doc support

This commit is contained in:
Vitor Santos Costa
2014-12-19 23:47:50 +00:00
parent 21d379bfb6
commit ad2df06d2b
6 changed files with 30 additions and 21 deletions

View File

@@ -32,7 +32,7 @@
term_to_atom/2
]).
/** @defgrou CharsIO Operations on Sequences of Codes.
/** @defgroup CharsIO Operations on Sequences of Codes.
@ingroup YAPLibrary
Term to sequence of codes conversion, mostly replaced by engine code.

View File

@@ -1,4 +1,12 @@
% A library to implement queues of NB Terms
/**
@defgroup DBQUeue Non-baacktrackable queues in YAP.
@ingroup YAPLibrary
@{
A library to implement queues of NB Terms
@{
*/
:- module(nbqueue, [
nb_enqueue/2,
@@ -50,3 +58,7 @@ nb_dequeue_all(Ref) :-
nb_dequeue_size(Ref, Size) :-
prolog:'$nb_size'(Ref, Size).
/**
@}
*/

View File

@@ -1,13 +1,12 @@
/** @defgroup DBUsage Memory Usage in Prolog Data-Base
@ingroup YAPLibrary
@{
/**
@defgroup DBUsage Memory Usage in Prolog Data-Base
@ingroup YAPLibrary
@{
This library provides a set of utilities for studying memory usage in YAP.
The following routines are available once included with the
`use_module(library(dbusage))` command.
This library provides a set of utilities for studying memory usage in YAP.
The following routines are available once included with the
`use_module(library(dbusage))` command.
*/
:- module(dbusage, [
@@ -19,11 +18,7 @@ The following routines are available once included with the
]).
/** @pred db_usage
Give general overview of data-base usage in the system.
Give general overview of data-base usage in the system.
*/
db_usage :-
statistics(heap,[HeapUsed,HeapFree]),
@@ -199,3 +194,6 @@ sumall([p(Cls,CSz,ISz)|LEDAll], TEDCls0, TEDCls, TEDCSz0, TEDCSz, TEDISz0, TEDIS
TEDISzI is ISz+TEDISz0,
sumall(LEDAll, TEDClsI, TEDCls, TEDCSzI, TEDCSz, TEDISzI, TEDISz).
/**
@}
*/