doc

C/arrays.c

@@ -15,7 +15,13 @@
 *									 *
 *************************************************************************/
 
-/** @defgroup YAPArrays Named Arrays
+/** 
+
+@file arrays.c
+
+@namespace prolog
+
+@addtogroup YAPArrays Named Arrays
 @ingroup extensions
 @{
 

C/atomic.c

@@ -1,4 +1,3 @@
-
 /*************************************************************************
  *									 *
  *	 YAP Prolog 							 *
@@ -22,15 +21,20 @@ static char SccsId[] = "%W% %G%";
 /**
  * @file atomic.c
  *
+ * @namespace prolog
+ *
+/
+
+/**
  * @defgroup Predicates_on_Atoms Predicates on Atoms and Strings
  *    @ingroup builtins
  * @{
-
- @brief The following predicates are used to manipulate atoms, strings, lists of
- codes and lists of chars:
-
- \toc
-
+ * 
+ *  @brief The following predicates are used to manipulate atoms, strings, lists of
+ * codes and lists of chars:
+ *
+ * \toc
+ *
 */
 
 #define HAS_CACHE_REGS 1

C/attvar.c

@@ -18,6 +18,15 @@
 static char SccsId[] = "%W% %G%";
 #endif
 
+/**
+ * @file   attvar.c
+ * @author VITOR SANTOS COSTA <vsc@VITORs-MBP-2.lan>
+ * @date   Mon Apr 30 09:31:59 2018
+ * 
+ * @brief  attributed variables
+ * @namespace prolog
+ * 
+ */
 #include "Yap.h"
 
 #include "Yatom.h"

C/bb.c

@@ -18,6 +18,17 @@
 static char     SccsId[] = "%W% %G%";
 #endif
 
+/**
+ * @file   bb.c
+ * @author VITOR SANTOS COSTA <vsc@VITORs-MBP-2.lan>
+ * @date   Mon Apr 30 09:32:54 2018
+ * 
+ * @brief  blackboard
+ * 
+ * @namespace prolog
+ * 
+ */
+
 
 /** @defgroup BlackBoard The Blackboard
 @ingroup builtins

C/bignum.c

@@ -17,6 +17,17 @@
 #ifdef SCCS
 static char SccsId[] = "%W% %G%";
 #endif
+/**
+ * @file   bignum.c
+ * @author VITOR SANTOS COSTA <vsc@VITORs-MBP-2.lan>
+ * @date   Mon Apr 30 09:34:59 2018
+ * 
+ * @brief  BigNums and More
+ * @namespace prolog
+ * 
+ * 
+ * 
+ */
 
 #include "Yap.h"
 #include "Yatom.h"

C/cmppreds.c

@@ -16,6 +16,18 @@
 *									 *
 *************************************************************************/
 
+/**
+ * @file   cmppreds.c
+ * @author VITOR SANTOS COSTA <vsc@VITORs-MBP-2.lan>
+ * @date   Mon Apr 30 09:35:58 2018
+ * 
+ * @brief  comparison
+ *
+ * @namespace prolog
+ * 
+ * 
+ * 
+ */
 ///    @file cmppreds.c
 
 /**

C/dbase.c

@@ -18,6 +18,20 @@
 static char SccsId[] = "%W% %G%";
 #endif
 
+/**
+ * @file   dbase.c
+ * @author VITOR SANTOS COSTA <vsc@VITORs-MBP-2.lan>
+ * @date   Mon Apr 30 09:36:46 2018
+ * 
+ * @brief  record and other forms of storing terms.
+ *
+ * @namespace prolog
+ * 
+ * 
+ * 
+ */
+
+
 /** @defgroup Internal_Database Internal Data Base
 @ingroup builtins
 @{

C/eval.c

@@ -17,8 +17,19 @@
 #ifdef SCCS
 static char SccsId[] = "%W% %G%";
 #endif
-
-//! @file eval.c
+/**
+ * @file   eval.c
+ * @author VITOR SANTOS COSTA <vsc@VITORs-MBP-2.lan>
+ * @date   Mon Apr 30 09:37:59 2018
+ * 
+ * @brief  is/2
+ *
+ *
+ * @namespace prolog
+ * 
+ * 
+ * 
+ */
 
 //! @{
 

C/exec.c

@@ -18,6 +18,19 @@
 static char SccsId[] = "@(#)cdmgr.c	1.1 05/02/98";
 #endif
 
+/**
+ * @file   exec.c
+ * @author VITOR SANTOS COSTA <vsc@VITORs-MBP-2.lan>
+ * @date   Mon Apr 30 13:48:35 2018
+ * 
+ * @brief  meta-call
+ *
+ * @namespace prolog
+ *
+ * 
+ * 
+ */
+
 #include "absmi.h"
 #include "attvar.h"
 #include "cut_c.h"
@@ -121,7 +134,8 @@ inline static bool CallMetaCall(Term t, Term mod USES_REGS) {
 
 /**
  * Transfer control to a meta-call in ARG1, cut up to B.
- * @method Yap_ExecuteCallMetaCall
+ * 
+ * @param  g                     goal
  * @param  mod                     current module
  * @return                         su
  */
@@ -1574,8 +1588,8 @@ bool Yap_exec_absmi(bool top, yap_reset_t has_reset) {
 
 /**
  * Fails computation up to choice-point bb
- * @method Yap_fail_all
- * @param  USES_REGS    [description]
+ * 
+ * @param  USES_REGS    thread support
  */
 void Yap_fail_all(choiceptr bb USES_REGS) {
   yamop *saved_p, *saved_cp;

C/flags.c

@@ -30,6 +30,10 @@
 
 */
 
+/*
+ * @namespace prolog
+ * /
+
 // this is where  we define flags
 #define INIT_FLAGS 1
 

C/stack.c

@@ -1260,19 +1260,21 @@ static Term all_calls(bool internal USES_REGS) {
   return Yap_MkApplTerm(f, 6, ts);
 }
 
-/**
- * report the current status of the stacks up to level $N$
- *
- * @param depth
- *
- * @return data on the current program counter
- */
 
 Term Yap_all_calls(void) {
   CACHE_REGS
     return all_calls(true PASS_REGS);
 }
 
+/**
+ * @pred current_stack( +Depth )
+ *
+ * report the current status of the stacks up to level $N$
+ *
+ * @param Depth
+ *
+ * @return data on the current Prolog stack.
+ */
 static Int current_stack(USES_REGS1) {
   Term t;
   while ((t = all_calls(false PASS_REGS)) == 0L) {

C/utilpreds.c

@@ -1617,8 +1617,9 @@ p_term_variables( USES_REGS1 )	/* variables in term t		 */
 
 /**
  * Exports a nil-terminated list with all the variables in a term.
- * @param[in] the term
- * @param[in] the arity of the calling predicate (required for exact garbage collection).
+ * @param[t] the term
+ * @param[arity] the arity of the calling predicate (required for exact garbage collection).
+ * @param[USES_REGS] threading
  */
 Term
 Yap_TermVariables( Term t, UInt arity USES_REGS )	/* variables in term t		 */