Tree [db31b8] master /
History



File Date Author Commit
m4 2013-02-18 Lionel Debroux Lionel Debroux [e3d3bc] libtifiles: for dealing with ZIP files, use an ...
AUTHORS 2012-08-11 Lionel Debroux Lionel Debroux [0df2f9] tfdocgen, gfm, tilp: some updates, wording and ...
COPYING 2011-08-01 Lionel Debroux Lionel Debroux [5232db] all: upgrade COPYING files and FSF addresses em...
ChangeLog 2013-03-10 Lionel Debroux Lionel Debroux [db31b8] tfdocgen, libticonv, libtifiles, libticables, l...
INSTALL 2012-05-06 Lionel Debroux Lionel Debroux [7a9119] tfdocgen, libticonv, libtifiles, libticables, l...
Makefile.am 2010-08-19 Lionel Debroux Lionel Debroux [98b620] all: minor changes to make autotools definition...
Makefile.in 2012-08-05 Lionel Debroux Lionel Debroux [b5201d] tfdocgen, libticonv, libtifiles, libticables, l...
NEWS 2006-01-14 Romain Liévin Romain Liévin [19d61d] Imported this project from my SVN to those one.
README 2006-01-14 Romain Liévin Romain Liévin [19d61d] Imported this project from my SVN to those one.
aclocal.m4 2013-03-05 Lionel Debroux Lionel Debroux [1f4210] libticonv, libtifiles, libticables, libticalcs,...
compile 2012-05-06 Lionel Debroux Lionel Debroux [7a9119] tfdocgen, libticonv, libtifiles, libticables, l...
config.guess 2012-05-06 Lionel Debroux Lionel Debroux [7a9119] tfdocgen, libticonv, libtifiles, libticables, l...
config.h.in 2011-09-06 Lionel Debroux Lionel Debroux [6c2fcb] all: reconfigure with Autoconf 2.68 and libtool...
config.sub 2012-06-23 Lionel Debroux Lionel Debroux [d72b1a] libticonv, libtifiles, libticables, libticalcs,...
configure 2013-02-18 Lionel Debroux Lionel Debroux [e3d3bc] libtifiles: for dealing with ZIP files, use an ...
configure.ac 2013-02-19 Lionel Debroux Lionel Debroux [b2c48f] tfdocgen: use AC_CONFIG_HEADERS([config.h]) ins...
depcomp 2012-05-06 Lionel Debroux Lionel Debroux [7a9119] tfdocgen, libticonv, libtifiles, libticables, l...
install-sh 2012-05-06 Lionel Debroux Lionel Debroux [7a9119] tfdocgen, libticonv, libtifiles, libticables, l...
ltmain.sh 2013-02-18 Lionel Debroux Lionel Debroux [e3d3bc] libtifiles: for dealing with ZIP files, use an ...
missing 2012-05-06 Lionel Debroux Lionel Debroux [7a9119] tfdocgen, libticonv, libtifiles, libticables, l...
mkinstalldirs 2011-02-08 Lionel Debroux Lionel Debroux [a6beb3] tfdocgen, libticonv, libtifiles, libticables, l...
tfdocgen.1 2007-12-26 Romain Liévin Romain Liévin [bc0468] Updated description.
tfdocgen.c 2012-08-07 Lionel Debroux Lionel Debroux [31e26a] tfdocgen, libticonv, libtifiles, libticables, l...
tfdocgen.dsp 2006-01-14 Romain Liévin Romain Liévin [19d61d] Imported this project from my SVN to those one.
tfdocgen.dsw 2006-01-14 Romain Liévin Romain Liévin [19d61d] Imported this project from my SVN to those one.

Read Me

1) About folders:
-----------------

- tmpl: html template (style sheet, images) + hand-written doc
- html: html generated doc
- text: text generated doc


2) About comments:
------------------

Each function or definition starts with a specific comment header like this:

/**
 * tifiles_get_error:
 * @number: error number (see file_err.h for list).
 * @message: a newly allocated string which contains corresponding error *message.
 *
 * Attempt to match the message corresponding to the error number. The returned
 * string must be freed when no longer needed.
 *
 * Return value: 0 if error has been caught, the error number otherwise (propagation).
 **/
TIEXPORT int TICALL function
 
@parameter: this is a parameter
#function: html link to function
%name: report to parameter (written in italic)

Current restrictions: the documentation generator is not very well protected
against syntax errors. You must follow these rules:
- line with @ must be on 1 line (wrapping is allowed).
- function declaration must be on 1 line (same as above).
- the '*' _must_ be placed as showed.

3) About doc:
-------------

apiindex.html contains list of topics with anchor like this:
	[] Entry points (tifiles.c)
	
The title describes a set of functions. The parser will scan them in tifiles.c and will
build the tifiles.html file.

Once all files generated, it will modify the apiindex.html file for html link insertion.
	

3) About the documentation system:
----------------------------------

The processing is the following: each *.c or *.h source file is scanned for "/**" token up to
function or structure definition.

        *.[c|h] + tmpl -> html

The processor is a C-written program and works in 1 pass.

Romain.
-------