Improved the ROBOdoc documentation generation process.
authorPekka Riikonen <priikone@silcnet.org>
Sat, 2 Mar 2002 20:42:31 +0000 (20:42 +0000)
committerPekka Riikonen <priikone@silcnet.org>
Sat, 2 Mar 2002 20:42:31 +0000 (20:42 +0000)
50 files changed:
INSTALL
TODO
doc/example_silcd.conf.in
lib/doc/LIBINDEX
lib/doc/building.html [new file with mode: 0644]
lib/silcclient/DIRECTORY
lib/silcclient/silcclient.h
lib/silccore/DIRECTORY
lib/silccore/silcargument.h
lib/silccore/silcauth.h
lib/silccore/silcchannel.h
lib/silccore/silccommand.h
lib/silccore/silcid.h
lib/silccore/silcidcache.h
lib/silccore/silcmode.h
lib/silccore/silcnotify.h
lib/silccore/silcpacket.h
lib/silccore/silcprivate.h
lib/silccrypt/DIRECTORY
lib/silccrypt/silchmac.h
lib/silccrypt/silcrng.h
lib/silcmath/DIRECTORY
lib/silcmath/Makefile.am
lib/silcmath/silcmath.h
lib/silcmath/silcmp.h
lib/silcsftp/DIRECTORY
lib/silcsftp/silcsftp.h
lib/silcsftp/silcsftp_fs.h
lib/silcske/DIRECTORY
lib/silcske/silcske.h
lib/silcske/silcske_groups.h
lib/silcske/silcske_payload.h
lib/silcske/silcske_status.h
lib/silcutil/DIRECTORY
lib/silcutil/silcbuffmt.h
lib/silcutil/silcconfig.h
lib/silcutil/silcfileutil.h
lib/silcutil/silchashtable.h
lib/silcutil/silclist.h
lib/silcutil/silclog.h
lib/silcutil/silcmemory.h
lib/silcutil/silcmutex.h
lib/silcutil/silcnet.h
lib/silcutil/silcprotocol.h
lib/silcutil/silcschedule.h
lib/silcutil/silcsockconn.h
lib/silcutil/silcthread.h
util/robodoc/Source/analyser.c
util/robodoc/Source/generator.c
util/robodoc/Source/generator.h

diff --git a/INSTALL b/INSTALL
index 71fb1948b6d30ce340bdbe54c44c3f4c0122fe30..ca34dbe7fbf0ea66d00df2eadb3c9d1e65dbf517 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -47,8 +47,8 @@ will work in single thread only.
 `--enable-ipv6'
 
    The `configure' will attempt to check for IPv6 support in your system.
-   However, if it fails, but you still want to compile in the IPv6 support
-   you can give --enable-ipv6 option to force the IPv6 support.
+However, if it fails, but you still want to compile in the IPv6 support
+you can give --enable-ipv6 option to force the IPv6 support.
 
 Basic Installation
 ==================
diff --git a/TODO b/TODO
index 17d3fdf8b7a89d90364370da0b9464529a775f0f..52f0769d1ccb21d91954e5ea2b4646d67d6d5838 100644 (file)
--- a/TODO
+++ b/TODO
@@ -83,6 +83,8 @@ TODO/bugs In SILC Server
 TODO/bugs In SILC Libraries
 ===========================
 
+ o Fix possible buffer overflows in silc_id_render function.
+
  o WIN32 silc_net_create_connection_async does not work the same way
    than on Unix.  Do it with threads on WIN32.  The function works but
    is not actually async currently.
index 89dc2f26ba545b74f1c5d2f0161600cdf61d9bc0..5bac8bcc20fc049224656e881f01dc320a02c75e 100644 (file)
@@ -356,7 +356,6 @@ ServerConnection {
        Host = "10.2.1.7";
        Passphrase = "verysecret";
        #Publickey = "/path/to/the/public.key";
-       VersionID = 1;
        Params = "normal";
        Backup = false;
 };
@@ -391,7 +390,6 @@ RouterConnection {
        Port = 706;
        Passphrase = "verysecret";
        #Publickey = "/path/to/the/public.key";
-       VersionID = 1;
        Params = "normal";
        Initiator = true;
        #BackupHost = "10.2.1.6";
index fdee154e66003217133cd37561386d7a9e841ca4..c90f7f00d0b2c52b11619d9d05fce61b15002079 100644 (file)
@@ -27,15 +27,20 @@ of the Toolkit always delivers the latest version of this reference manual.
 <br /><br /><br />
 <li><a href="intro_reference.html">Introduction to the Manual</a><br />
 <li><a href="programming_conv.html">Programming Conventions</a><br />
+<li><a href="building.html">Building the Toolkit</a>
+
+<br /><br />
+<b>Toolkit Reference</b>
+<br /><br />
 @BODY@
 
-<br /><br /><br />
+<br /><br />
 <b>Resource Links</b>
 <br /><br />
 Please refer to these outside links for more information about the SILC 
 project and SILC Protocol.
 
-<br /><br /><br />
+<br /><br />
 <li><a href="http://silcnet.org">SILC Project Website</a><br />
 <li><a href="http://silcnet.org/?page=docs">SILC Protocol Documentation</a><br />
 <li><a href="http://silcnet.org/?page=whitepaper">SILC White Paper</a><br />
diff --git a/lib/doc/building.html b/lib/doc/building.html
new file mode 100644 (file)
index 0000000..c0a7f64
--- /dev/null
@@ -0,0 +1,178 @@
+<big><b>Building the Toolkit</b></big>
+
+<br />&nbsp;<br />
+SILC Toolkit works on various platforms, such as on several Unix systems and 
+on Windows.  Building of the Toolkit on some platform may differ from the
+other.  This document describes how to build the Toolkit from the sources,
+to create linkable libraries and binaries, on all platforms the Toolkit
+support.
+
+<br />&nbsp;<br />
+The building instructions for all platforms are also included in the Toolkit
+package.  Please refer to the INSTALL file for general building instructions
+for Unix systems, README.WIN32 for building on Windows systems, and
+README.MACOSX for building on Mac OS X.
+
+<br />&nbsp;<br />
+<li><a href="#unix">Building on Unix & Linux</a><br />
+<li><a href="#windows">Building on Windows</a><br />
+<li><a href="#macosx">Building on Mac OS X</a>
+
+<br />&nbsp;<br />&nbsp;<br />
+<b><a name="unix"></a>Building on Unix & Linux</b>
+
+<br />&nbsp;<br />
+Building the Toolkit on Unix will produce binaries of all libraries, and
+SILC Client and SILC Server.  The Toolkit package includes also Client and
+Server as an example applications, and they are compiled automatically.
+The libraries are compiled to provide staticly linkable libraries.  Two
+libraries are produced: libsilc.a and libsilcclient.a.  The libsilc.a includes
+everything else except the Client library.  The libsilcclient.a includes
+only the Client library.
+
+<br />&nbsp;<br />
+To build Toolkit on Unix systems, give commands:
+
+<br />&nbsp;<br />
+<tt>
+./configure<br />
+make
+</tt>
+
+<br />&nbsp;<br />
+On some systems you may need to give "gmake" command instead of "make".  The
+./configure can take several options as arguments.  To see them all give
+command:
+
+<br />&nbsp;<br />
+<tt>./configure --help</tt>
+
+<br />&nbsp;<br />
+The most important configuration options you may consider to use are:
+
+<br />&nbsp;<br />
+<tt>--enable-debug</tt>
+
+<br />&nbsp;<br />
+If you would like to enable the debugging for the compiled binaries
+you can give this option to the `configure'.  It is recommended to use
+this option when you are doing development with Toolkit.  It is helpful
+to enable run-time debugging.
+
+<br />&nbsp;<br />
+<tt>--with-gmp=PATH</tt>
+
+<br />&nbsp;<br />
+If you wish to use GMP library for arbitrary precision arithmetic
+library instead of using the MPI library included in the package, you can
+give the --with-gmp=PATH option to the `configure'.  The PATH is the path
+to the GMP library in your system.
+
+<br />&nbsp;<br />
+<tt>--disable-asm</tt>
+
+<br />&nbsp;<br />
+If you have trouble compiling the assembler optimized code in the
+package or does not want to use them, you can give the --disable-asm
+option to the `configure' script.  This will assure that assembler
+optimized code is not compiled in.
+
+<br />&nbsp;<br />
+<tt>--disable-threads</tt>
+
+<br />&nbsp;<br />
+If you do not want to compile the programs with multi threads support
+you can give --disable-threads option.  This will disable the SILC Thread
+API and SILC Mutex API.  Furthermore if SILC Thread API is used when this
+option is used, the routines work, but do not work in threads (are run
+in the calling process and can block the process).
+
+<br />&nbsp;<br />
+<tt>--enable-ipv6</tt>
+
+<br />&nbsp;<br />
+The `configure' will attempt to check for IPv6 support in your system.
+However, if it fails, but you still want to compile in the IPv6 support
+you can give --enable-ipv6 option to force the IPv6 support.
+
+<br />&nbsp;<br />
+After compilation you can install the Toolkit into your system by giving
+the command:
+
+<br />&nbsp;<br />
+<tt>make install</tt>
+
+
+<br />&nbsp;<br />&nbsp;<br />
+<b><a name="windows"></a>Building on Windows</b>
+
+<br />&nbsp;<br />
+The Toolkit can be compiled several different ways on Windows.  However,
+this document describes the method to build the Toolkit to produce native
+Win32 binaries.  The Toolkit package can also be compiled on Cygwin and
+MinGW.  For these systems please refer to the README.WIN32 file in the
+Toolkit package.
+
+<br />&nbsp;<br />
+The Toolkit package includes ready MSVC++ Workspace files, that will 
+automatically compile the Toolkit.  The MSVC++ workspace and project files
+resides in the win32/ subdirectory of the Toolkit package.  The `silc.dsw'
+file is the workspace file that automatically supports compiling the Toolkit
+and to generate the SILC Core DLL and SILC Client DLL libraries.
+
+<br />&nbsp;<br />
+The SILC Core DLL is named as libsilc and will generate libsilc.dll, and
+the SILC Client DLL is named as libsilcclient and will generate
+libsilcclient.dll.  Both of the projects also automatically generates
+libsilc.lib and libsilcclient.lib import libraries that may be used to
+link against a client application.
+
+<br />&nbsp;<br />
+Generally you do not need to do any specific settings to compile the
+Toolkit.  However, you must compile the libsilc before compiling the
+libsilclient, since the SILC Client DLL depends on the SILC Core DLL.
+You may compile the DLLs as either Release or Debug version.  Just select
+the preferred method of compilation.  The Debug version will compile the
+SILC Toolkit with run-time debugging support, which is recommended when
+doing development with the Toolkit.
+
+<br />&nbsp;<br />&nbsp;<br />
+<b><a name="macosx"></a>Building on Mac OS X</b>
+
+<br />&nbsp;<br />
+Building the Toolkit on Mac OS X is almost identical on compiling on Unix
+system.  The reason for this is that the Mac OS X is Unix based operating
+system.  To build the Toolkit on Mac OS X, give the following commands:
+
+<br />&nbsp;<br />
+<tt>
+setenv CFLAGS -no-cpp-precomp<br />
+./configure powerpc<br />
+make
+</tt>
+
+<br />&nbsp;<br />
+The ./configure can take several options as arguments.  To see them all give
+command:
+
+<br />&nbsp;<br />
+<tt>./configure --help</tt>
+
+<br />&nbsp;<br />
+If you do not want to compile the applications, or they do not compile on
+your system, you can also choose to compile only the libraries, and skip
+all applications.  In this case, before giving the "make" command, go
+to the lib/ subdirectory, and give "make" command there:
+
+<br />&nbsp;<br />
+<tt>
+cd lib/<br />
+make
+</tt>
+
+<br />&nbsp;<br />
+After compilation you can install the Toolkit into your system by giving
+the command:
+
+<br />&nbsp;<br />
+<tt>make install</tt>
index 5e72559e04eb4cb8e62ba7a5c2283113af858f40..7fa78c18b5835f2e62fb4ae9d88bfe3e440f4cc5 100644 (file)
@@ -5,11 +5,15 @@
 @LINK=silcclient.html:Client Library Interface
 -->
 
-<BIG><B>SILC Client Library</B></BIG>
-<BR /><BR />
-<B>Introduction</B>
+<big><b>SILC Client Library</b></big>
+<br />
+<small>Directory: lib/silcclient/</small>
+<br />
+<small>Library: libsilcclient.a, libsilcclient.lib</small>
+<br /><br />
+<b>Introduction</b>
 
-<BR /><BR />
+<br /><br />
 SILC Client Library is SILC Client implementation without the actual user 
 interface. The library uses common and core components of SILC protocol from
 lib/silccore library and normal utility routines from lib/silcutil library.
@@ -18,7 +22,7 @@ without actual user interface.  The library provides the API for the
 application which it can use to implement generally whatever user interface
 it wants.
 
-<BR /><BR />
+<br /><br />
 The `silcclient.h' file defines the function prototypes that application must
 implement in order to be able to create the user interface with the
 library.  The idea is that the application can implement whatever user
@@ -28,5 +32,5 @@ it does not include any user interface specific issues such as window
 handling or item handling on the screen etc.  These does not interest
 the library.
 
-<BR /><BR />
+<br /><br />
 @LINKS@
index f1b3ebc93fe5c5154cd8a14d1ab5dfa64900d756..2dcb7a58a8aaf9bf9c05b1d984a5f303d1afe741 100644 (file)
@@ -17,7 +17,7 @@
 
 */
 
-/****h* silcclient/SilcClientAPI
+/****h* silcclient/Client Library Interface
  *
  * DESCRIPTION
  *
index c1fc2bed1a9f701678d9d71b0e2202386026a742..12cd09ca40413eba350c9938be6f7cc999029b6a 100644 (file)
 @LINK=silcpacket.html:Packet Protocol Interface
 -->
 
-<BIG><B>SILC Core Library</B></BIG>
-<BR /><BR />
-<B>Introduction</B>
+<big><b>SILC Core Library</b></big>
+<br />
+<small>Directory: lib/silccore/</small>
+<br />
+<small>Library: libsilc.a, libsilc.lib</small>
+<br /><br />
+<b>Introduction</b>
 
-<BR /><BR />
+<br /><br />
 SILC Core Library includes all the core components of the SILC Protocol.
 It provides routines to encode and decode all SILC packet payloads defined
 in the protocol specification.  It provides packet assembling and parsing
 routines, and routines for sending private message and channel messages.
 
-<BR /><BR />
+<br /><br />
 @LINKS@
index 9f3eebfe6947100bcf4d7795807943bef1907170..62c945fcd7be5507de4c03f405b0783efad1d719 100644 (file)
@@ -17,7 +17,7 @@
 
 */
 
-/****h* silccore/SilcArgumentAPI
+/****h* silccore/SILC Argument Interface
  *
  * DESCRIPTION
  *
index 84d6789c461ca6b3ab14a59ab41dd5bc61e1b1b4..008a8ead0fe10f6dbe04bb598904c25f6b2a7eb9 100644 (file)
@@ -18,7 +18,7 @@
 
 */
 
-/****h* silccore/SilcAuthAPI
+/****h* silccore/SILC Authentication Interface
  *
  * DESCRIPTION
  *
index 792c31c83627f2ecc7b02be8b92f40c9ed86f4dc..fe4ce3a2aff2b59f86533d8399b985c26341e43a 100644 (file)
@@ -18,7 +18,7 @@
 
 */
 
-/****h* silccore/SilcChannelAPI
+/****h* silccore/SILC Channel Interface
  *
  * DESCRIPTION
  *
index bbd1fcf46f8589e8a0a6f2469beb1a1bde4be407..46e7ddd1d96d4bd1356256a6e115faac3b16f299 100644 (file)
@@ -18,7 +18,7 @@
 
 */
 
-/****h* silccore/SilcCommandAPI
+/****h* silccore/SILC Command Interface
  *
  * DESCRIPTION
  *
index 821285ee044408e2ecff05887514d7fdc1107a7f..1bfbe44e5db7d30c77b0b8ded32d2377f710ba4e 100644 (file)
@@ -18,7 +18,7 @@
 
 */
 
-/****h* silccore/SilcIDAPI
+/****h* silccore/SILC ID Interface
  *
  * DESCRIPTION
  *
index 64c8bf9c6b038cd9f032e4259f706483f70d7b1c..8d2170a01be89e981e3c08e2fd9b75eea72ecec8 100644 (file)
@@ -18,7 +18,7 @@
 
 */
 
-/****h* silccore/SilcIDCacheAPI
+/****h* silccore/SILC ID Cache Interface
  *
  * DESCRIPTION
  * 
index 4f42778ddc3a9dda69da170e8ffe214a8a16eed6..4e365bf75c01d05a37644b4dd0d47986abd31c45 100644 (file)
@@ -18,7 +18,7 @@
 
 */
 
-/****h* silccore/SilcMode
+/****h* silccore/SILC Modes
  *
  * DESCRIPTION
  *
index 67e8894f34b8ee1f70f19842a56448dda41bea52..b95f09fd050d6b6fca66128762a4a0a5a8726fa5 100644 (file)
@@ -18,7 +18,7 @@
 
 */
 
-/****h* silccore/SilcNotifyAPI
+/****h* silccore/SILC Notify Interface
  *
  * DESCRIPTION
  *
index b4f1a8e4a1a58fa39b080faa68fa12c7fdc2bf74..b5789fe0142dc6d9f401dad752b5a784bbf214c4 100644 (file)
@@ -17,7 +17,7 @@
 
 */
 
-/****h* silccore/SilcPacketAPI
+/****h* silccore/Packet Protocol Interface
  *
  * DESCRIPTION
  *
index e5da22eab400bee1672536f7b75df2d24feb1234..d4f6abff617330f5c93fd5183246a2c77dff919c 100644 (file)
@@ -18,7 +18,7 @@
 
 */
 
-/****h* silccore/SilcPrivateAPI
+/****h* silccore/SILC Private Message Interface
  *
  * DESCRIPTION
  *
index 7b95063422ea6b8897f720af76f15bb2fb02e22f..370ccdc261f4caad9575b79f13ae2aa13c2cca7b 100644 (file)
@@ -3,22 +3,26 @@
 @FILENAME=silccryptlib.html
 @LINK=silcrng_intro.html:Introduction to SILC RNG
 @LINK=silcrng.html:SILC RNG Interface
+@LINK=silchmac.html:SILC HMAC Interface
 @LINK=silccipher.html:SILC Cipher API
 @LINK=silchash.html:SILC Hash API
-@LINK=silchmac.html:SILC HMAC API
 @LINK=silcpkcs.html:SILC PKCS API
 -->
 
-<BIG><B>SILC Crypto Library</B></BIG>
-<BR /><BR />
-<B>Introduction</B>
+<big><b>SILC Crypto Library</b></big>
+<br />
+<small>Directory: lib/silccrypt/</small>
+<br />
+<small>Library: libsilc.a, libsilc.lib</small>
+<br /><br />
+<b>Introduction</b>
 
-<BR /><BR />
+<br /><br />
 SILC Crypto Library provides cryptographic routines for applications.  It
 provides interfaces for ciphers, hash functions, HMACs and public key
 cryptosystems.  In addition is also provides interfaces for cryptographically
 strong random number generator.
 
-<BR /><BR />
+<br /><br />
 @LINKS@
 
index a317a3f56830e9c41edecb54ef0dd34a28788b85..37d28c5985b25a4d99d49a6af5c4e7ecaee2ed69 100644 (file)
@@ -20,7 +20,7 @@
 #ifndef SILCHMAC_H
 #define SILCHMAC_H
 
-/****h* silccrypt/SilcHMACAPI
+/****h* silccrypt/SILC HMAC Interface
  *
  * DESCRIPTION
  *
index a5da3c348ad2f514be44cd6f1f18ef8ed9c05273..9a173ffb7cc8d7d3de327d46bcdbd6c9a22972ea 100644 (file)
@@ -17,7 +17,7 @@
 
 */
 
-/****h* silccrypt/SilcRNGAPI
+/****h* silccrypt/SILC RNG Interface
  *
  * DESCRIPTION
  *
index af8bc2733ae1e6887b0d8e67b52a51129caebf69..33c6d2f575b3396af352bee4aa24c732cbd5f971 100644 (file)
@@ -5,14 +5,18 @@
 @LINK=silcmath.html:SILC Math Interface
 -->
 
-<BIG><B>SILC Math Library</B></BIG>
-<BR /><BR />
+<big><b>SILC Math Library</b></big>
+<br />
+<small>Directory: lib/silcmath/</small>
+<br />
+<small>Library: libsilc.a, libsilc.lib</small>
+<br /><br />
 <B>Introduction</B>
 
-<BR /><BR />
+<br /><br />
 SILC Math Library provides arbitrary precision artichmetic routines for
 public key cryptosystems, prime number generation routines, and other
 math utility functions for applications.
 
-<BR /><BR />
+<br /><br />
 @LINKS@
index d1e75ab6d8af9347233e767a305880d34cd064d5..6ef0c4f4d97bf827dae5454e7e6591fc09cf7b6b 100644 (file)
@@ -28,8 +28,14 @@ noinst_LIBRARIES = libsilcmath.a
 
 if SILC_MP_NSS_MPI
 MP_SOURCE = mp_mpi.c
+if SILC_DIST_TOOLKIT
+MP_HEADERS = mpi/mpi.h mpi/mplogic.h mpi/mpprime.h mpi/mpi-config.h
+else
+MP_HEADERS =
+endif
 else
 MP_SOURCE = mp_gmp.c
+MP_HEADERS =
 endif
 
 libsilcmath_a_SOURCES = \
@@ -43,7 +49,8 @@ include_HEADERS =     \
        mp_gmp.h        \
        mp_mpi.h        \
        silcmath.h      \
-       silcmp.h
+       silcmp.h        \
+       $(MP_HEADERS)
 endif
 
 EXTRA_DIST = *.h
index b5f28791a2f64452343cf773adff3aa6e16501fe..d9233d30690fd1deae81f2acd0ab4db2b438ae3e 100644 (file)
@@ -18,7 +18,7 @@
 
 */
 
-/****h* silcmath/SilcMathAPI
+/****h* silcmath/SILC Math Interface
  *
  * DESCRIPTION
  *
index c0bb7087bbfc71c8136821b4496ce0d5fd9ea6bc..72d71acb97459ed714c2114282f03d9600b3700a 100644 (file)
@@ -18,7 +18,7 @@
  
 */
 
-/****h* silcmath/SilcMPAPI
+/****h* silcmath/SILC MP Interface
  *
  * DESCRIPTION
  *
index 088a6975d1675579991477833942417ac022f1d4..ee5e02389569a7ceaced028d3b856e1652f9872a 100644 (file)
@@ -5,15 +5,19 @@
 @LINK=silcsftp_fs.html:SFTP Filesystems Interface
 -->
 
-<BIG><B>SILC SFTP Library</B></BIG>
-<BR /><BR />
-<B>Introduction</B>
+<big><b>SILC SFTP Library</b></big>
+<br />
+<small>Directory: lib/silcsftp/</small>
+<br />
+<small>Library: libsilc.a, libsilc.lib</small>
+<br /><br />
+<b>Introduction</b>
 
-<BR /><BR />
+<br /><br />
 SILC SFTP Library provides SSH File Transfer Protocol client and server
 implementation.  The SFTP protocol is the mandatory file transfer protocol
 used for file transfers in the SILC protocol.  The same interface is used
 for SFTP client and SFTP server.
 
-<BR /><BR />
+<br /><br />
 @LINKS@
index 1e438d9bbe6be89d4fd8e49e8b2323d2c9ef423e..ef5735a8cc097ac37b5306a0a5e8a25e22555de6 100644 (file)
@@ -20,7 +20,7 @@
 #ifndef SILCSFTP_H
 #define SILCSFTP_H
 
-/****h* silcsftp/SilcSFTPAPI
+/****h* silcsftp/SILC SFTP Interface
  *
  * DESCRIPTION
  *
index ea719282ae2c0a4f27e7f1e53b98d8886989a4b1..ae222ab71e5fcd021fa1e4b913736b6a73c81cc5 100644 (file)
@@ -20,7 +20,7 @@
 #ifndef SILCSFTP_FS_H
 #define SILCSFTP_FS_H
 
-/****h* silcsftp/SilcSFTPFSAPI
+/****h* silcsftp/SFTP Filesystems Interface
  *
  * DESCRIPTION
  *
index 0fbae5476204b2afc868786f28b4523c8a43588a..c37dd945b1cd46a62fc57ea03b4ed175701a0af5 100644 (file)
@@ -7,14 +7,18 @@
 @LINK=silcske_payload.html:SKE Payloads
 -->
 
-<BIG><B>SILC Key Exchange Library</B></BIG>
-<BR /><BR />
-<B>Introduction</B>
+<big><b>SILC Key Exchange Library</b></big>
+<br />
+<small>Directory: lib/silcske/</small>
+<br />
+<small>Library: libsilc.a, libsilc.lib</small>
+<br /><br />
+<b>Introduction</b>
 
-<BR /><BR />
+<br /><br />
 SILC Key Exchange (SKE) Library, is an implementation of the SKE protocol.
 It provides the key exchange protocol for all SILC applications.
 
-<BR /><BR />
+<br /><br />
 @LINKS@
 
index 5c552e03b7051962ea6eee7359f15d9c2eaa4522..ffb25b0aa62b4c1f59276c9b9b7ad634482fcee2 100644 (file)
@@ -20,7 +20,7 @@
 #ifndef SILCSKE_H
 #define SILCSKE_H
 
-/****h* silcske/SilcSKEAPI
+/****h* silcske/SILC SKE Interface
  *
  * DESCRIPTION
  *
index acbdb58ababcd127b8f143a43d552fc6bee42b73..551bf16834beaf6697b9b37c447d98ddc97dd3da 100644 (file)
@@ -17,7 +17,7 @@
 
 */
 
-/****h* silcske/SilcSKEGroups
+/****h* silcske/SKE Diffie Hellman Groups
  *
  * DESCRIPTION
  *
index 9c12ba577042dc40928a190d18b06d687400de01..22755524470848d3ec545b03a4eb8601f9ec9ef2 100644 (file)
@@ -17,7 +17,7 @@
 
 */
 
-/****h* silcske/SilcSKEPayloads
+/****h* silcske/SKE Payloads
  *
  * DESCRIPTION
  *
index 2c55ad4ac3df2afadac50ed135ec52af67864237..908a807dd1cf122307af6af2a35d4bd9baf9782b 100644 (file)
@@ -17,7 +17,7 @@
 
 */
 
-/****h* silcske/SilcSKEStatuses
+/****h* silcske/SKE Status Types
  *
  * DESCRIPTION
  *
index a48ad6b02d2862d91380dca1c788a20df9bc3916..a0362fb2fceb48f4ef7a7d0f6ae4f843a0ffd3dd 100644 (file)
 @LINK=silczip.html:SILC Zip API
 -->
 
-<BIG><B>SILC Utility Library</B></BIG>
-<BR /><BR />
-<B>Introduction</B>
+<big><b>SILC Utility Library</b></big>
+<br />
+<small>Directory: lib/silcutil/</small>
+<br />
+<small>Library: libsilc.a, libsilc.lib</small>
+<br /><br />
+<b>Introduction</b>
 
-<BR /><BR />
+<br /><br />
 SILC Utility Library provides various utility routines for the applications.
 For example, it provides the application's main loop, called the SILC
 Scheduler.  It can handle all kinds of tasks, like socket connections and
@@ -32,5 +36,5 @@ timeout tasks.  The SILC Utility Library also provides various buffer
 management routines.  All of these routines work on multiple platforms
 such as Unix and WIN32.
 
-<BR /><BR />
+<br /><br />
 @LINKS@
index e69e90bb6c6ce31cf11b0fe213cf5c30a807b8b8..42d55d1b1823a04f142e7e1d88c6b590e6e323cd 100644 (file)
@@ -18,7 +18,7 @@
 
 */
 
-/****h* silcutil/SilcBufferFormatAPI
+/****h* silcutil/SILC Buffer Format Interface
  *
  * DESCRIPTION
  *
index 2e70e01f8ca312c09fd02dbd85def28e710feaca..06073e4f2f9352c9bcb9d93aba757e3a049edc11 100644 (file)
@@ -18,7 +18,7 @@
 
 */
 
-/****h* silcutil/SilcConfigAPI
+/****h* silcutil/SILC Config Interface
  *
  * DESCRIPTION
  *
index 76892b275d89ce816f868dc770a4c3a41c013072..80624ed5e89f0d3bb247077f75e0d01be73a20b3 100644 (file)
@@ -17,7 +17,7 @@
 
 */
 
-/****h* silcutil/SilcFileUtilAPI
+/****h* silcutil/Silc File Util Interface
  *
  * DESCRIPTION
  *
index 2b186c957301757bb095b634dfc95d7aa0b58c1d..6e04f6b75103d712d00835421f961b9ce64bd63e 100644 (file)
@@ -17,7 +17,7 @@
 
 */
 
-/****h* silcutil/SilcHashTableAPI
+/****h* silcutil/SILC Hash Table Interface
  *
  * DESCRIPTION
  *
@@ -33,7 +33,7 @@
  * an extended interface where caller can specify its own hash and comparison
  * functions.
  *
- * There are two ways tro traverse the entire hash table if this feature
+ * There are two ways to traverse the entire hash table if this feature
  * is needed. There exists a foreach function that calls a foreach
  * callback for each entry in the hash table. Other way is to use
  * SilcHashTableList structure and traverse the hash table inside while()
index 326837e10c4ed4d2835238499b3f585dae143c5c..2d56241e98ca7c03562bb30b7f8ff980d3b57c9f 100644 (file)
@@ -18,7 +18,7 @@
 
 */
 
-/****h* silcutil/SilcListAPI
+/****h* silcutil/SILC List Interface
  *
  * DESCRIPTION
  *
index 01425a89c859473a71f336317d48f9d95121f1e5..30cfa07051811ae291fae38b81a0fd4cffbd55f0 100644 (file)
@@ -18,7 +18,7 @@
 
 */
 
-/****h* silcutil/SilcLogAPI
+/****h* silcutil/SILC Logging Interface
  *
  * DESCRIPTION
  *
index 8046909cfd7928d681505dfb9591024434ec73bc..691cc698295db0cd921877c2dd0273224dc6328c 100644 (file)
@@ -17,7 +17,7 @@
 
 */
 
-/****h* silcutil/SilcMemoryAPI
+/****h* silcutil/SILC Memory Interface
  *
  * DESCRIPTION
  *
index 076b667bfe05295c8c5cb7c76b21c1fb666267ee..e1f1b26ce9816cc308e0e057d49be1ab684de229 100644 (file)
@@ -18,7 +18,7 @@
 
 */
 
-/****h* silcutil/SilcMutexAPI
+/****h* silcutil/SILC Mutex Interface
  *
  * DESCRIPTION
  *
index 931b3d82fe38aa3554d5eab688f97250ba51ff90..262d86a95e9ca4160a32e2cfce85bc9a1a6983e9 100644 (file)
@@ -18,7 +18,7 @@
 
 */
 
-/****h* silcutil/SilcNetAPI
+/****h* silcutil/SILC Net Interface
  *
  * DESCRIPTION
  *
index a6e4463c4df02da008bb549f8f3cb11d5498673f..74393280160567cc87cc216e695f287d3943f85a 100644 (file)
@@ -18,7 +18,7 @@
 
 */
 
-/****h* silccore/silcprotocol.h
+/****h* silccore/SILC Protocol Interface
  *
  * DESCRIPTION
  *
index b0e315fda678cb64bd727b3c2348587ecd4e52bd..95e279a333eaec58bae3c80d4e3f83e5dd970f02 100644 (file)
@@ -20,7 +20,7 @@
 
 */
  
-/****h* silcutil/SilcScheduleAPI
+/****h* silcutil/SILC Schedule Interface
  *
  * DESCRIPTION
  *
index ea47d3da1e0b716847b88c90fdf404aea3e7a018..7f6ea5f9c35ec0a6f0a02218205ed69e49549802 100644 (file)
@@ -18,7 +18,7 @@
 
 */
 
-/****h* silcutil/SilcSocketConnectionAPI
+/****h* silcutil/SILC Socket Interface
  *
  * DESCRIPTION
  *
index 26493ab8f6062380de1e42c830f35062b464b30f..06becee09d32015feba4500786eb995d27ede943 100644 (file)
@@ -18,7 +18,7 @@
 
 */
 
-/****h* silcutil/SilcThreadAPI
+/****h* silcutil/SILC Thread Interface
  *
  * DESCRIPTION
  *
index 50af048108a9416cfd35d0a8154431e68c4050fd..0a6c08745993a3afa86b3b8883aabfff9a9e85a3 100644 (file)
@@ -73,8 +73,12 @@ RB_Analyse_Document (FILE * document)
            {
              RB_Say ("found header [line %5d]: \"%s\"\n",
                      line_number, new_header->name);
+#if 0
              if ((new_header->function_name
                   = RB_Function_Name (new_header->name)) == NULL)
+#endif
+             if ((new_header->function_name
+                  = RB_Function_Name (line_buffer)) == NULL)
                {
                  RB_Panic ("Can't determine the \"function\" name.\n");
                }
@@ -408,14 +412,17 @@ RB_Find_Header_Name (void)
   skip_while (isspace (*cur_char));
   if (*cur_char)
     {
-      char *end_char, old_char;
-
-      end_char = cur_char + RB_WordLen (cur_char);
-      old_char = *end_char;
-      *end_char = '\0';
-      cur_char = RB_StrDup (cur_char);
-      *end_char = old_char;
-      return (cur_char);
+      char *n;
+      int len;
+
+      if (strchr(cur_char, '\n'))
+       *strchr(cur_char, '\n') = '\0';
+
+      len = RB_WordLen(cur_char);
+
+      n = calloc(len + 1, sizeof(*cur_char));
+      strncpy(n, cur_char, len);
+      return n;
     }
   return (NULL);
 }
index c1d90780a38326b9aadb31426e933fe8827b2b49..bbc5b666572f071a59d9390044319ce633a83188 100644 (file)
@@ -73,7 +73,7 @@ RB_Generate_Documentation (
            }
         }
 
-      RB_Generate_Header_Start (dest_doc, cur_header);
+      RB_Generate_Header_Start (dest_doc, cur_header, src_name);
 
       next_line = cur_header->contents;
       item_type = RB_Find_Item (&next_line, &item_line);
@@ -296,7 +296,8 @@ RB_Generate_Doc_Start (
                      int item_type;
                      char *next_line, *item_line = NULL;
                    
-                     RB_Generate_Header_Start (dest_doc, cur_header);
+                     RB_Generate_Header_Start (dest_doc, cur_header, 
+                                               src_name);
 
                      next_line = cur_header->contents;
                      item_type = RB_Find_Item (&next_line, &item_line);
@@ -548,7 +549,8 @@ RB_Generate_Doc_End (FILE * dest_doc, char *name)
  */
 
 void
-RB_Generate_Header_Start (FILE * dest_doc, struct RB_header *cur_header)
+RB_Generate_Header_Start (FILE * dest_doc, struct RB_header *cur_header,
+                         const char *src_name)
 {
   char *cook_link;
 
@@ -593,6 +595,13 @@ RB_Generate_Header_Start (FILE * dest_doc, struct RB_header *cur_header)
                     "</FONT></B><BR><BR>\n\n",
                     cur_header->function_name,
                     cur_header->function_name);
+         else if (cur_header->type == MAIN_HEADER)
+           fprintf (dest_doc, 
+                    "\n<FONT SIZE=\"+2\" COLOR=\"#000055\"><B>"
+                    "<A NAME=\"%s\">%s</A>"
+                    "</FONT></B><BR><SMALL>Header: %s</SMALL><BR><BR>\n\n",
+                    cur_header->function_name,
+                    cur_header->function_name, src_name);
          else
            fprintf (dest_doc, 
                     "\n<FONT SIZE=\"+2\" COLOR=\"#000055\"><B>"
index 2460fb4baba850d1bab3171ad5e4e3611c76f804..c886974c3da53b75a7eefecbd8872f725a9886aa 100644 (file)
@@ -8,7 +8,7 @@ void RB_Generate_Header_Name (FILE *, char *);
 void RB_Generate_Item_Name (FILE *, int);
 void RB_Generate_Doc_Start (FILE *, char *, char *, char);
 void RB_Generate_Doc_End (FILE *, char *);
-void RB_Generate_Header_Start (FILE *, struct RB_header *);
+void RB_Generate_Header_Start (FILE *, struct RB_header *, const char *);
 void RB_Generate_Header_End (FILE *, struct RB_header *);
 int RB_HTML_Extra (FILE * dest_doc, int item_type, char *cur_char);
 void RB_Generate_Index (FILE * dest, char *name);