Add documentation

This commit is contained in:
Vítor Santos Costa
2015-11-18 15:06:25 +00:00
parent 7236d4a527
commit ce8a19d381
88 changed files with 7982 additions and 2083 deletions

View File

@@ -1,13 +1,14 @@
/**
@defgroup DBQUeue Non-baacktrackable queues in YAP.
@ingroup library
@{
A library to implement queues of NB Terms
@{
* @file dbqueues.yap
* @author VITOR SANTOS COSTA <vsc@VITORs-MBP.lan>
* @date Tue Nov 17 15:01:49 2015
*
* @brief A library to support queues with no-backtrackable queues.
*
*
*/
:- module(nbqueue, [
nb_enqueue/2,
nb_dequeue/2,
@@ -15,6 +16,14 @@ A library to implement queues of NB Terms
nb_size/2
]).
/**
* @defgroup dbqueues Non-backtrackable queues in YAP.
* @ingroup library
A library to implement queues of NB Terms
*/
:- unhide('$init_nb_queue').
:- unhide('$nb_enqueue').
@@ -59,6 +68,3 @@ nb_dequeue_all(Ref) :-
nb_dequeue_size(Ref, Size) :-
prolog:'$nb_size'(Ref, Size).
/**
@}
*/