doxygen support

cgi.pl

@@ -36,8 +36,8 @@
 
 :- use_foreign_library(foreign(cgi), install_cgi).
 
-/** <module> Read CGI parameters
-@ingroup SWILibrary
+/** <module> Simple CGI form
+    @ingroup SWILibrary
 
 Below is a very simple CGI script  that prints the passed parameters. To
 test it, compile this program using the   command below, copy it to your

crypt.pl

@@ -37,7 +37,11 @@
 
 :- use_foreign_library(foreign(crypt), install_crypt).
 
-%	crypt(+Passwd, ?Encripted).
+/** <module> Encrypt a passsword
+    @ingroup SWIclib
+ */
+
+%%	crypt(+Passwd, ?Encripted).
 %
 %	Used to test an encrypted passwd or create one.  In the latter
 %	case, the first 2 letter must be instantiated

filesex.pl

@@ -41,7 +41,7 @@
 	  ]).
 
 /** <module> Extended operations on files
-@ingroup SWILibrary
+    @ingroup SWILibrary
 
 This module provides additional operations on   files.  This covers both
 more  obscure  and  possible  non-portable    low-level  operations  and

memfile.pl

@@ -47,3 +47,7 @@
 :- use_module(library(shlib)).
 
 :- use_foreign_library(foreign(memfile)).
+
+/** <module> Memory File
+    @ingroup SWIclib
+ */

mime.pl

@@ -39,7 +39,7 @@
 :- license(gpl).
 
 /** <module> Parse MIME documents
-@ingroup SWILibrary
+    @ingroup SWILibrary
 
 This module defines an interface to   the rfc2045 (MIME) parsing library
 by Double Precision, Inc, part of the   maildrop system. This library is

process.pl

@@ -60,7 +60,7 @@
 		     ]).
 
 /** <module> Create processes and redirect I/O
-@ingroup SWILibrary
+    @ingroup SWIclib
 
 The module library(process) implements interaction  with child processes
 and unifies older interfaces such   as  shell/[1,2], open(pipe(command),

prolog_server.pl

@@ -37,6 +37,10 @@
 :- use_module(library(lists)).
 :- use_module(library(socket)).
 
+/** <module> TCP Server 
+    @ingroup socket
+ */
+
 %%	prolog_server(?Port, +Options)
 %
 %	Create a TCP/IP based server  on  the   given  Port,  so you can

rlimit.pl

@@ -33,6 +33,10 @@
 	  [ rlimit/3			% +Limit, -Old, +New
 	  ]).
 
+/** <module> Process Resource Management
+ *  @ingroup SWIclib
+ */
+
 %	rlimit(+Limit, -Old, +New)
 %
 %	Query and set POSIX resource limits.  Provided resources are:

sha.pl

@@ -40,6 +40,10 @@
 
 :- use_foreign_library(foreign(sha4pl)).
 
+/** <module> SHA hash 
+ * @ingroup clib
+ */
+
 %%	sha_hash(+Data, -Hash, +Options) is det
 %
 %	Hash is the SHA hash of Data, The conversion is controlled

socket.pl

@@ -52,6 +52,10 @@
 	  ]).
 :- use_module(library(shlib)).
 
+/** <module> Socket routines
+ *  @ingroup SWIclib
+ */
+
 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 These predicates are documented in the source-distribution of the package
 `clib'.  See also the SWI-Prolog home-page at http://www.swi-prolog.org

streaminfo.pl

@@ -31,6 +31,10 @@
 	  [ stream_info/1		% +Stream
 	  ]).
 
+/** <module> Stream Information
+  *  @ingroup SWIclib
+  */
+
 :- use_foreign_library(foreign(streaminfo)).
 
 %%	stream_info(+Stream) is det.

streampool.pl

@@ -39,6 +39,10 @@
 :- use_module(library(quintus)).
 :- use_module(library(debug)).
 
+/** <module> Stream Pool Management
+ *  @ingroup socket
+ */
+
 :- meta_predicate
 	add_stream_to_pool(+, :).
 
@@ -47,7 +51,7 @@
 :- dynamic
 	pool/2.				% Stream, Action
 
-%	add_stream_to_pool(+Stream :Goal)
+%%	add_stream_to_pool(+Stream :Goal)
 %
 %	Call Goal whenever there is input on Stream.
 
@@ -58,14 +62,14 @@
 register_stream(Stream, Goal) :-
 	assert(pool(Stream, Goal)).
 
-%	delete_stream_from_pool(+Stream)
+%%	delete_stream_from_pool(+Stream)
 %
 %	Retract stream from the pool
 
 delete_stream_from_pool(Stream) :-
 	retractall(pool(Stream, _)).
 
-%	close_stream_pool
+%%	close_stream_pool
 
 close_stream_pool :-
 	(   retract(pool(Stream, _)),
@@ -74,7 +78,7 @@
 	;   true
 	).
 
-%	dispatch_stream_pool(+TimeOut)
+%%	dispatch_stream_pool(+TimeOut)
 %
 %	Wait for input on one or more streams and handle that.  Wait for
 %	at most TimeOut seconds (0 means infinite).
@@ -105,7 +109,7 @@
 			  goal_failed(Action, stream_pool))
 	).
 
-%	stream_pool_main_loop
+%%	stream_pool_main_loop
 %
 %	Keep handling input from the streams in the pool until they have
 %	all died away.

syslog.pl

@@ -34,8 +34,8 @@
 	    closelog/0
 	  ]).
 
-/** <module> Unix syslog interface
-@ingroup SWILibrary
+/** <module> Unix system logger interface
+    @ingroup SWIclib
 
 This library provides an interface to   the  Unix syslog() facility. The
 interface is an almost direct translation of  the POSIX syslog API, with

time.pl

@@ -52,6 +52,10 @@
 	alarm_at(+, 0, -, +),
 	current_alarm(?, :, ?, ?).
 
+/** <module> SWI-style timer/alarms
+    @ingroup SWIclib
+*/
+
 %%	alarm(+Time, :Callable, -Id) is det.
 %%	alarm(+Time, :Callable, -Id, +Options) is det.
 %

udp_broadcast.pl

@@ -35,6 +35,7 @@
 	     ]).
 
 /** <module> A UDP Broadcast Bridge
+     @ingroup socket
 
 SWI-Prolog's broadcast library provides a  means   that  may  be used to
 facilitate publish and subscribe communication regimes between anonymous

uid.pl

@@ -48,7 +48,7 @@
 :- use_foreign_library(foreign(uid)).
 
 /** <module> User and group management on Unix systems
-@ingroup SWILibrary
+    @ingroup SWIclib
 
 This module provides and interface  to   user  and  group information on
 Posix systems. In addition, it allows for changing user and group ids.

unix.pl

@@ -43,7 +43,7 @@
 :- use_module(library(shlib)).
 
 /** <module> Unix specific operations
-@ingroup SWILibrary
+    @ingroup SWIclib
 
 The library(unix) library provides the commonly  used Unix primitives to
 deal with process management.  These  primitives   are  useful  for many

uri.pl

@@ -54,7 +54,7 @@
 :- use_foreign_library(foreign(uri)).
 
 /** <module> Process URIs
-@ingroup SWILibrary
+    @ingroup SWIclib
 
 This  library  provides   high-performance    C-based   primitives   for
 manipulating URIs. We decided for a  C-based implementation for the much

uuid.pl

@@ -33,7 +33,7 @@
 	  ]).
 
 /** <module> Universally Unique Identifier (UUID) Library
-@ingroup SWILibrary
+    @ingroup SWIclib
 
 The library provides operations on UUIDs.   Please consult other sources
 for understanding UUIDs and  the  implications   of  the  different UUID