doc support

This commit is contained in:
Vítor Santos Costa
2015-01-04 23:58:23 +00:00
parent a87f1040ac
commit 3164ed2d61
124 changed files with 625 additions and 645 deletions

View File

@@ -2,7 +2,7 @@
% SWI emulation.
% written in an on-demand basis.
%% @defgroup SWILibrary Compatibility with SWI-Prolog and Other Prolog systems
%% @defgroup swi Compatibility with SWI-Prolog and Other Prolog systems
/**
@@ -148,21 +148,9 @@ that concatenated give _A12_.
*/
goal_expansion(atom_concat(A,B,C),atomic_concat(A,B,C)).
%goal_expansion(arg(A,_,_),_) :- nonvar(A), !, fail.
/** @pred arg(+ _N_,+ _T_, _A_) is iso
Succeeds if the argument _N_ of the term _T_ unifies with
_A_. The arguments are numbered from 1 to the arity of the term.
The current version will generate an error if _T_ or _N_ are
unbound, if _T_ is not a compound term, of if _N_ is not a positive
integer. Note that previous versions of YAP would fail silently
under these errors.
@}
*/
goal_expansion(arg(A,B,C),genarg(A,B,C)).
% make sure we also use

View File

@@ -16,11 +16,11 @@
*************************************************************************/
/**
*
* @file blobs.c
* @{
* @file blobs.c
*
* @addtogroup swi-c-interface
*
* @{
*/
#include <Yap.h>
@@ -250,7 +250,7 @@ PL_unregister_blob_type(PL_blob_t *type)
{
fprintf(stderr,"PL_unregister_blob_type not implemented yet\n");
return FALSE;
}
xs}
void
Yap_install_blobs(void)

View File

@@ -140,9 +140,10 @@ UserCPredicate(char *a, CPredicate def, unsigned long int arity, Term mod, int f
CurrentModule = cm;
}
//! @{
/** @defgroup swi-ATOMS Atom Construction
* @ingroup swi-c-interface
* @{
* */
@@ -177,11 +178,12 @@ X_API char* PL_atom_nchars(atom_t a, size_t *len) /* SAM check type */
return s;
}
/** @}
//! @}
/** @{
*
* @defgroup swi-term_references Term References
* @ingroup swi-c-interface
* @{
* */
/** @brief duplicate a term reference
@@ -226,14 +228,17 @@ X_API void PL_reset_term_refs(term_t after)
}
/** @}
* @defgroup swi-term_manipulation Term Manipulation
*/
//! @{
/** @defgroup swi-term_manipulation Term Manipulation
* @ingroup swi-c-interface
* */
/**
* @defgroup swi-get-operations Reading Terms
* @ingroup swi-term_manipulation
* @{
* */
/** @brief *name is assigned the name and *arity the arity if term ts, or the operaton fails.
@@ -647,10 +652,11 @@ X_API int PL_get_string(term_t t, char **s, size_t *len)
* @}
* */
//! @{
/**
* @defgroup swi-unify-operations Unifying Terms
* @ingroup swi-term_manipulation
* @{
* */

View File

@@ -9,7 +9,10 @@
*************************************************************************/
/**
@file swi.h
@{
@file swi.h
@defgroup swi-c-interface SWI-Prolog Foreign Language Interface
@ingroup ChYInterface
@@ -30,8 +33,6 @@
* Prolog has all the information necessary to perform its memory management without special precautions
* from the C programmer.
@{
*/
void Yap_swi_install(void);
void Yap_install_blobs(void);