From ad2df06d2b49b27f6c1596fbc19624bf09e2217d Mon Sep 17 00:00:00 2001 From: Vitor Santos Costa Date: Fri, 19 Dec 2014 23:47:50 +0000 Subject: [PATCH] doc support --- docs/doxfull.rc | 2 +- docs/yap.md | 7 +++---- library/charsio.yap | 2 +- library/dbqueues.yap | 14 +++++++++++++- library/dbusage.yap | 24 +++++++++++------------- pl/control.yap | 2 +- 6 files changed, 30 insertions(+), 21 deletions(-) diff --git a/docs/doxfull.rc b/docs/doxfull.rc index 3ba9684bb..06cbae3b4 100644 --- a/docs/doxfull.rc +++ b/docs/doxfull.rc @@ -769,7 +769,7 @@ WARN_LOGFILE = # INPUT = /Users/vsc/git/yap-6.3/packages/cplint/mcintyre.pl #INPUT = /Users/vsc/git/yap-6.3/packages/R/R.pl -INPUT = foreigns.yap docs/yap.md pl swi C H include os packages library CXX OPTYap +INPUT = docs/yap.md pl swi C H include os packages library CXX OPTYap # This tag can be used to specify the character encoding of the source files diff --git a/docs/yap.md b/docs/yap.md index ecc63b32d..f739e7679 100644 --- a/docs/yap.md +++ b/docs/yap.md @@ -162,11 +162,10 @@ DTAI group of KULeuven. For general information on ProbLog 1 and 2, please see -+ The real R interface package developed by Nicos Angelopoulos, ++ The `real` R interface package developed by Nicos Angelopoulos, Vítor Santos Costa, João Azevedo, Jan Wielemaker, and Rui Camacho. - -+ YAP includes the yap2swi library that ports to YAP code from ++ YAP includes the `yap2swi` library that ports to YAP code from of SWI's PL interface. This includes the Input/Output Layer, the SWI Foreign Language Interface, and the RDF, archive, clib, http, odbc, plunit, semweb, sgml, and zlib packages written by Jan Wielemaker. Please do refer to the SWI-Prolog home page: @@ -804,7 +803,7 @@ will be used: + @ref YAPOS -+ @ref Database ++ @ref Internal_Database + @ref Sets diff --git a/library/charsio.yap b/library/charsio.yap index bba0db824..ac0c562eb 100644 --- a/library/charsio.yap +++ b/library/charsio.yap @@ -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. diff --git a/library/dbqueues.yap b/library/dbqueues.yap index 00223b820..7744def54 100644 --- a/library/dbqueues.yap +++ b/library/dbqueues.yap @@ -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). + +/** + @} +*/ \ No newline at end of file diff --git a/library/dbusage.yap b/library/dbusage.yap index 7945c6267..3b378840b 100644 --- a/library/dbusage.yap +++ b/library/dbusage.yap @@ -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). +/** + @} +*/ \ No newline at end of file diff --git a/pl/control.yap b/pl/control.yap index cc9dfc2d9..7c35760b0 100644 --- a/pl/control.yap +++ b/pl/control.yap @@ -17,7 +17,7 @@ /** -@addtogroup YAPControl +@defgroup YAPControl @{ */