docs

pl/arith.yap

@@ -36,6 +36,7 @@
 
 /** @defgroup CompilerAnalysis Internal Clause Rewriting
     @ingroup YAPCompilerSettings
+    @{
 
   YAP supports several clause optimisation mechanisms, that
   are designed to improve execution of arithmetic
@@ -59,7 +60,6 @@
 
 */
 
-%% @{
 
 /** @pred expand_exprs(- _O_,+ _N_)
 	Control term expansion during compilation.

pl/arithpreds.yap

@@ -15,14 +15,13 @@
 *									 *
 *************************************************************************/
 
-%% @{
 
 /**
   @file arithpreds.yap
 
   @addtogroup arithmetic_preds
 
-
+ @{
 */
 
 :- system_module(arithmetic_predicates, [

pl/atoms.yap

@@ -26,7 +26,7 @@
 
 /**
  * @addtogroup Predicates_on_Atoms
- *
+ * @{
 */
 
 /** @pred  atom_concat(+ As, ? A)

pl/boot.yap

@@ -19,11 +19,11 @@
   @file boot.yap
   @brief YAP bootstrap
 
-@{
 
   @addtogroup TopLevel Top-Level and Boot Predicates
 
   @ingroup builtins
+  @{
 
 
 */

pl/bootutils.yap

@@ -3,6 +3,7 @@
   @short utilities
 
   @addtogroup Internal_Database
+ @{
   */
 
 /** @pred  recordaifnot(+ _K_, _T_,- _R_) 
@@ -41,3 +42,4 @@ recordzifnot(K,T,R) :-
 recordzifnot(K,T,R) :-
         recordz(K,T,R).
 
+%% @}

pl/builtins.yap

@@ -21,8 +21,7 @@
 
   @addtogroup YAPControl Control Predicates
   @ingroup builtins
-
-@{
+  @{
 
 */
 

pl/callcount.yap

@@ -39,11 +39,11 @@ implementation.
 
  */
 
-%% @{  
-
-/** @defgroup Call_Counting Counting Calls
-@ingroup Profiling
-  
+/**
+ @defgroup Call_Counting Counting Calls
+ @ingroup Profiling
+ @{ 
+ 
 Predicates compiled with YAP's flag call_counting set to
 `on` update counters on the numbers of calls and of
 retries. Counters are actually decreasing counters, so that they can be

pl/checker.yap

@@ -22,12 +22,11 @@
         '$syntax_check_multiple'/2,
         '$syntax_check_single_var'/2]).
 
-%% @{
-
 /**
 
-@defgroup   YAPStyle Checker
-    @ingroup  YAPCompilerSettings
+   @defgroup   YAPStyle Checker
+   @ingroup  YAPCompilerSettings
+   @{
 
 YAP implements a style-checker thay currently verifies whether:
 

pl/control.yap

@@ -83,11 +83,9 @@
 
 @addtogroup YAPControl
 @ingroup builtins
-
+@{
 */
 
-%% @{
-
 /** @pred  forall(: _Cond_,: _Action_)
 
 

pl/dbload.yap

@@ -30,10 +30,9 @@
 %%
 % @defgroup YAPBigLoad Loading Large Tables
 % @ingroup YAPConsulting
-% 
+% @{
 % @brief Fast and  Exo Loading
 %
-% @{
 
 /*!
  * @pred load_mega_clause( +Stream ) is detail

pl/debug.yap

@@ -24,6 +24,7 @@
 
 /**
   @defgroup Deb_Interaction Interacting with the debugger
+@{
   @ingroup YAPProgramming
 
 Debugging with YAP is similar to debugging with C-Prolog. Both systems
@@ -237,6 +238,8 @@ be lost.
 
 */
 
+
+
 /*-----------------------------------------------------------------------------
 
 				spy

pl/depth_bound.yap

@@ -18,6 +18,7 @@
 /**
 
 @defgroup DepthLimited Depth Limited Search
+@{
 @ingroup extensions
 
 YAP implements various extensions to the default Prolog search. One of
@@ -27,9 +28,12 @@ the most iseful s restricting the maximum search depth.
  :-
 system_module( '$_depth_bound', [depth_bound_call/2], []).
 
-%depth_bound_call(A,D) :-
-%write(depth_bound_call(A,D)), nl, fail.
+%% @pred depth_bound_call(A,D)
+%
+% CallError _A_ with maximum stack_el depth_reduction _B_.
+%
 depth_bound_call(A,D) :-
 	'$execute_under_depth_limit'(A,D).
 
 
+%% @}

pl/eam.yap

@@ -23,6 +23,7 @@
   * 
   * @brief  Extended Abstract Machine
   * @defgroup EAM Extended Abstract Machine
+  * @{
   * @ingroup extensions
   * 
   * 
@@ -54,3 +55,5 @@ eamconsult(File):- eam, eam,                    %fails if eam is disable
                 assert((user:term_expansion((A :- B),(A :- C)):- eamtrans(B,C))),
                 eam, ( consult(File) ; true), eam,
 		abolish(user:term_expansion,2).
+
+%% @}

pl/hacks.yap

@@ -32,6 +32,7 @@
 	   code_location/3]).
 
 /**
+ * @namespace yap_hacks
  *
  * @defgroup Hacks Low-level access
  * @ingroup builtins

pl/listing.yap

@@ -25,27 +25,27 @@
   */
 
 
-:- system_module( '$_listing', [listing/0,
+/*:- system_module( '$_listing', [listing/0,
         listing/1,
         portray_clause/1,
         portray_clause/2], []).
+*/
 
 /**
-  * @defgroup Listing  List predicates in a module
-  * @{
+  * @defgroup listingGroup  List predicates in a module
+  * 
   * @ingroup builtins
   *
+  * @{ 
 */
 
 
 :- use_system_module( '$_errors', ['$do_error'/2]).
-
-:- use_system_module( '$_preds', ['$clause'/4,
         '$current_predicate'/4]).
 
-/* listing : Listing clauses in the database
-
-*/
+/** @brief listing : Listing clauses in the database
+ *
+ */
 
 /** @pred  listing
 
@@ -347,3 +347,5 @@ portray_clause(Clause) :-
 	'$list_transform'(L,M).
 '$list_transform'([_|L],M) :-
 	'$list_transform'(L,M).
+
+%% @}