Add documentation

This commit is contained in:
Vítor Santos Costa
2015-11-18 15:06:25 +00:00
parent 7236d4a527
commit ce8a19d381
88 changed files with 7982 additions and 2083 deletions

View File

@@ -1,15 +1,43 @@
/** @defgroup Apply Apply Macros
@ingroup library
/**
* @file apply.yap
* @author VITOR SANTOS COSTA <vsc@VITORs-MBP.lan>
* @date Mon Nov 16 23:00:08 2015
*
* @brief Stub for maplist and friends
*
*
*/
:- module(apply_stub,[]).
/**
* @file apply.yap
* @defgroup apply_stub Apply Predicates
* @ingroup library
@{
This library provides a SWI-compatible set of utilities for applying a
predicate to all elements of a list. In practice, the library just forwards
definitions from the @ref maplist library library.
predicate to all elements of a list.
The apply library is a _stub_, it just forwards definitions to the
@ref maplist library. The predicates forwarded are:
- maplist/2,
- maplist/3,
- maplist/4,
- maplist/5,
- include/3,
- exclude/3,
- partition/4,
- partition/5
@}
*/
:- module(apply,[]).
:- reexport(library(maplist),
[maplist/2,
maplist/3,
@@ -22,6 +50,3 @@ definitions from the @ref maplist library library.
]).
/**
@}
*/