documentation improvemeents

This commit is contained in:
Vitor Santos Costa
2014-09-13 00:26:46 -05:00
parent 882eaca30c
commit b7ae9cb45e
9 changed files with 225 additions and 65 deletions

View File

@@ -1,5 +1,5 @@
/** @defgroup CLPQR Constraint Logic Programming over Reals
/** @defgroup clpr Constraint Logic Programming over Rationals and Reals
@ingroup SWILibrary
@{
@@ -24,8 +24,8 @@ explicitely before using it:
:- use_module(library(clpr)).
~~~~~
@defgroup CLPR_Solver_Predicates Solver Predicates
@ingroup CLPQR
@defgroup CLPR_Solver_Predicates Solver Predicates
@ingroup clpr
@{
@@ -75,8 +75,8 @@ result in an exception.
~~~~~
@defgroup CLPR_Unification Use of unification
@ingroup CLPQR
@defgroup CLPR_Unification Use of unification
@ingroup clpr
@{
Instead of using the `{}/1` predicate, you can also use the standard
@@ -102,31 +102,34 @@ X = 5.0
@defgroup CLPR_NonhYlinear_Constraints Non-Linear Constraints
@ingroup CLPQR
@defgroup CLPR_NonhYlinear_Constraints Non-Linear Constraints
@ingroup clpr
@{
In this version, non-linear constraints do not get solved until certain
conditions are satisfied. We call these conditions the isolation axioms.
conditions are satisfied. We call these conditions the _isolation_ axioms.
They are given in the following table.
~~~~~
A = B * C when B or C is ground or // A = 5 * C or A = B * 4 \\
A and (B or C) are ground // 20 = 5 * C or 20 = B * 4 \\
A = B * C when B or C is ground or // A = 5 * C or A = B * 4 \\
A and (B or C) are ground // 20 = 5 * C or 20 = B * 4 \\
A = B / C when C is ground or // A = B / 3
A and B are ground // 4 = 12 / C
A and B are ground // 4 = 12 / C
X = min(Y,Z) when Y and Z are ground or // X = min(4,3)
X = max(Y,Z) Y and Z are ground // X = max(4,3)
X = abs(Y) Y is ground // X = abs(-7)
X = min(Y,Z) when Y and Z are ground or // X = min(4,3)
X = max(Y,Z) Y and Z are ground // X = max(4,3)
X = abs(Y) Y is ground // X = abs(-7)
X = pow(Y,Z) when X and Y are ground or // 8 = 2 ^ Z
X = exp(Y,Z) X and Z are ground // 8 = Y ^ 3
X = Y ^ Z Y and Z are ground // X = 2 ^ 3
X = Y ^ Z Y and Z are ground // X = 2 ^ 3
X = sin(Y) when X is ground or // 1 = sin(Y)
X = cos(Y) Y is ground // X = sin(1.5707)
X = cos(Y) Y is ground // X = sin(1.5707)
X = tan(Y)
~~~~~
@}

View File

@@ -58,7 +58,7 @@ PROJECT_LOGO = misc/icons/yap_96x96x32.png
# entered, it will be relative to the location where doxygen was started. If
# left blank the current directory will be used.
OUTPUT_DIRECTORY = ../doxout
OUTPUT_DIRECTORY = /scratch/vitor/doxout
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
# directories (in 2 levels) under the output directory of each output format and

View File

@@ -901,8 +901,6 @@ being designed to work with the swig (@url(www.swig.org}) interface compiler.
@defgroup YAPProgramming Programming in YAP
@page Programming Programming in YAP
+ @ref Syntax
+ @ref Indexing
@@ -911,8 +909,6 @@ being designed to work with the swig (@url(www.swig.org}) interface compiler.
@defgroup SWILibrary SWI-Prolog Libraries and Packages
@page SWI The SWI-Prolog Library and Packages
+ @ref Read_Utilities Read Utilities
+ @ref shlib SWI-Prolog's shlib library
@@ -921,9 +917,9 @@ being designed to work with the swig (@url(www.swig.org}) interface compiler.
+ @ref archive
+ @ref CHR
+ @ref chr
+ @ref CLPQR
+ @ref clpr
+ @ref zlib
@@ -931,7 +927,7 @@ being designed to work with the swig (@url(www.swig.org}) interface compiler.
@page Packages The YAP Packages
+ @ref REAL
+ @ref real
+ @ref BDDs
@@ -939,6 +935,19 @@ being designed to work with the swig (@url(www.swig.org}) interface compiler.
+ @ref MYDDAS
@defgroup http The SWI The SWI http packages
Tthe package HTTP is a series of libraries developed by Jan Wielmaker
and the SWI-Prolog community for accessing and serving data on the
web. It supports lower-level transport protocols, but also
data-representation primitives, and more.
The port to YAP focussed on the client-side support. The server
package has not been as widely tested.
\toc
@page Compatibility Compatibility with Other Prolog systems
YAP has been designed to be as compatible as possible with