Add missing documentation

This commit is contained in:
Vítor Santos Costa
2016-01-20 22:18:17 +00:00
parent 8c7c258492
commit 77a5090276
9 changed files with 156 additions and 17 deletions

View File

@@ -15,11 +15,13 @@
* comments: comparing two prolog terms *
* *
*************************************************************************/
/// @file cmppreds.c
/** @defgroup Comparing_Terms Comparing Terms
/**
@defgroup Comparing_Terms Comparing Terms
@ingroup builtins
The following predicates are used to compare and order terms, using the
@@ -29,8 +31,7 @@ standard ordering:
variables come before numbers, numbers come before atoms which in turn
come before compound terms, i.e.: variables @< numbers @< atoms @<
compound terms.
+
Variables are roughly ordered by "age" (the "oldest" variable is put
+ Variables are roughly ordered by "age" (the "oldest" variable is put
first);
+
Floating point numbers are sorted in increasing order;

View File

@@ -16,9 +16,13 @@
*************************************************************************/
/** @defgroup Term_Modification Term Modification
/**
@file mavar.c
@defgroup Term_Modification Term Modification
@ingroup builtins
@{
It is sometimes useful to change the value of instantiated
variables. Although, this is against the spirit of logic programming, it
@@ -26,14 +30,14 @@ is sometimes useful. As in other Prolog systems, YAP has
several primitives that allow updating Prolog terms. Note that these
primitives are also backtrackable.
The `setarg/3` primitive allows updating any argument of a Prolog
compound terms. The `mutable` family of predicates provides
<em>mutable variables</em>. They should be used instead of `setarg/3`,
The setarg/3 primitive allows updating any argument of a Prolog
compound terms. The _mutable_ family of predicates provides
<em>mutable variables</em>. They should be used instead of setarg/3,
as they allow the encapsulation of accesses to updatable
variables. Their implementation can also be more efficient for long
deterministic computations.
@{
*/
@@ -315,7 +319,6 @@ p_update_mutable( USES_REGS1 )
return(TRUE);
}
static Int
/** @pred is_mutable(? _D_)
@@ -323,6 +326,7 @@ Holds if _D_ is a mutable term.
*/
static Int
p_is_mutable( USES_REGS1 )
{
Term t = Deref(ARG1);