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

@@ -51,7 +51,7 @@
aggregate_all(?,?,0,-).
/** <module> Aggregation operators on backtrackable predicates
@ingroup SWILibrary
@ingroup swi
This library provides aggregating operators over the solutions of a
predicate. The operations are a generalisation of the bagof/3, setof/3

View File

@@ -35,7 +35,7 @@
]).
/** <module> Base64 encoding and decoding
@ingroup SWILibrary
@ingroup swi
Prolog-based base64 encoding using DCG rules. Encoding according to
rfc2045. For example:

View File

@@ -48,7 +48,7 @@
listener/4.
/** <module> Event service
@ingroup SWILibrary
@ingroup swi
Generic broadcasting service. Broadcasts are made using the predicate
broadcast(+Templ). All registered `listeners' will have their goal

View File

@@ -57,7 +57,7 @@
]).
/** <module> Character code classification
@ingroup SWILibrary
@ingroup swi
This file implements the functionality of the corresponding Quintus
library based on SWI-Prolog's code_type/2 predicate. Please check the

View File

@@ -37,7 +37,7 @@
]).
/** <module> date time routines
@ingroup SWILibrary
@ingroup swi
*/
%% date_time_value(?Field:atom, +Struct:datime, -Value) is nondet.

View File

@@ -71,7 +71,7 @@ backtrace(N) :-
debug_context(thread).
/** <module> Print debug messages and test assertions
@ingroup SWILibrary
@ingroup swi
This library is a replacement for format/3 for printing debug messages.
Messages are assigned a _topic_. By dynamically enabling or disabling

View File

@@ -39,7 +39,7 @@
:- set_prolog_flag(generate_debug_info, false).
/** <module> Editor interface
@ingroup SWILibrary
@ingroup swi
This module implements the generic editor interface. It consists of two
extensible parts with little in between. The first part deals with

View File

@@ -48,7 +48,7 @@
:- endif.
/** <module> Error generating support
@ingroup SWILibrary
@ingroup swi
This module provides predicates to simplify error generation and
checking. It's implementation is based on a discussion on the SWI-Prolog

View File

@@ -36,7 +36,7 @@
:- use_module(library(lists)).
/** <module> Provide entry point for scripts
@ingroup SWILibrary
@ingroup swi
This library is intended for supporting PrologScript on Unix using the
=|#!|= magic sequence for scripts using commandline options. The entry

View File

@@ -41,7 +41,7 @@
/** <module> Non-backtrackable sets
@ingroup SWILibrary
@ingroup swi
This library provides a non-backtrackabe set. It is based on
nb_setarg/3. See the SWI-Prolog manual for details.

View File

@@ -29,10 +29,6 @@
the GNU General Public License.
*/
/** <module> occur check support
@ingroup SWILibrary
*/
:- module(occurs,
[ contains_term/2, % +SubTerm, +Term
contains_var/2, % +SubTerm, +Term
@@ -47,6 +43,10 @@
:- use_module(library(arg),
[genarg/3]).
/** <module> occur check support
@ingroup swi
*/
/* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
This is a SWI-Prolog implementation of the corresponding Quintus

View File

@@ -40,7 +40,7 @@
/** <module> Manage operators
@ingroup SWILibrary
@ingroup swi
Often, one wants to define operators to improve the readibility of some
very specific code. Operators in Prolog are global objects and changing

View File

@@ -40,7 +40,7 @@
:- use_module(library(lists)).
/** <module> Option list processing
@ingroup SWILibrary
@ingroup swi
The library(option) provides some utilities for processing option lists.
Option lists are commonly used as an alternative for many arguments.

View File

@@ -39,7 +39,7 @@
]).
/** <module> Operations on key-value lists
@ingroup SWILibrary
@ingroup swi
This module implements common operations on Key-Value lists, also known
as _Pairs_. Pairs have great practical value, especially due to

View File

@@ -31,7 +31,7 @@
:- reexport(pure_input).
/** <module> Pure I/O
@ingroup SWILibrary
@ingroup swi
This library provides pure list-based I/O processing for Prolog, where
the communication to the actual I/O device is performed transparently

View File

@@ -63,7 +63,7 @@
check_predicate_options(:).
/** <module> Access and analyse predicate options
@ingroup SWILibrary
@ingroup swi
This module provides the developers interface for the directive
predicate_options/3. This directive allows us to specify that e.g.,

View File

@@ -52,7 +52,7 @@
make_varnames_hook/5.
/** <module> Get detailed source-information about a clause
@ingroup SWILibrary
@ingroup swi
This module started life as part of the GUI tracer. As it is generally
useful for debugging purposes it has moved to the general Prolog

View File

@@ -58,7 +58,7 @@
]).
/** <module> Prolog syntax colouring support.
@ingroup SWILibrary
@ingroup swi
This module defines reusable code to colourise Prolog source.

View File

@@ -39,7 +39,7 @@
:- use_module(debug).
/** <module> Examine Prolog source-files
@ingroup SWILibrary
@ingroup swi
The modile prolog_source.pl provides predicates to open, close and read
terms from Prolog source-files. This may seem easy, but there are a

View File

@@ -43,7 +43,7 @@
:- use_module(library(error)).
/** <module> Pure Input from files
@ingroup SWILibrary
@ingroup swi
This module is part of pio.pl, dealing with _pure_ _input_: processing
input streams from the outside world using pure predicates, notably

View File

@@ -38,7 +38,7 @@
:- use_module( library(lists) ).
/** <module> Define Quasi Quotation syntax
@ingroup SWILibrary
@ingroup swi
Inspired by
[Haskell](http://www.haskell.org/haskellwiki/Quasiquotation), SWI-Prolog

View File

@@ -81,7 +81,7 @@
:- use_module(library(lists), [member/2]).
/** <module> Quintus compatibility
@ingroup SWILibrary
@ingroup swi
This module defines several predicates from the Quintus Prolog
libraries. Note that our library structure is totally different. If this

View File

@@ -45,7 +45,7 @@
:- use_module(library(error)).
/** <module> Read utilities
@ingroup SWILibrary
@ingroup swi
This library provides some commonly used reading predicates. As these
predicates have proven to be time-critical in some applications we moved

View File

@@ -39,7 +39,7 @@
:- use_module(library(lists)).
/** <module> Access compound arguments by name
@ingroup SWILibrary
@ingroup swi
This module creates a set of predicates to create a default instance,
access and modify records represented as a compound term.

View File

@@ -51,7 +51,7 @@
:- use_module(library(option)).
/** <module> Setting management
@ingroup SWILibrary
@ingroup swi
This library allows management of configuration settings for Prolog
applications. Applications define settings in one or multiple files

View File

@@ -44,7 +44,7 @@
:- set_prolog_flag(generate_debug_info, false).
/** <module> Utility library for loading foreign objects (DLLs, shared objects)
@ingroup SWILibrary
@ingroup swi
This section discusses the functionality of the (autoload)
library(shlib), providing an interface to manage shared libraries. We

View File

@@ -43,7 +43,7 @@
/** <module> Resource bounded thread management
@ingroup SWILibrary
@ingroup swi
The module library(thread_pool) manages threads in pools. A pool defines
properties of its member threads and the maximum number of threads that