[osiris-devel] 3.0.4-current development documentation?

[Thomas Jones]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

On Sunday 22 February 2004 14:02, Alexei Roudnev wrote:
> Who need documentation in so many formats? html + pdf is quite good
> combination.
>
> PS. I used 'doxigen' to generate API documentation (analog of JavaDoc), but
> remember, that it is not enough just to document system calls etc - we
> _ALWAYS_ created a few special _Doxigen only_ files to maintain big
> documents, indexes and so on.
>
> And - do not use such things to generate user's documentation, but generate
> reference manuals only.
>
> Alex
<snip>

Geez O'pete !!!! You are killing me.

XML is easily extensible to almost any other format with a standard DTD. AND 
can be utilized and referenced with readbility formulas(Dale-Chall, Flesch) 
so that even general user documentation can be compiled very quickly.

i.e. KDE document sourcing, etc.....

As for LaTeX ----- is very easy to transform this format to desktop reference 
materials, for various different platforms. Given that Osiris is not system 
dependant; this makes very good sense.

BTW --- doxygen "only" files are redundant. It would be considerably easier to 
just correctly format the comments directly into the sources. Why comment 
source code to make it incompatible with doxygen, then make another file for 
the same data that is compiled by said document.

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.2 (GNU/Linux)

iD8DBQFAOHBZQT2komo99ukRAmNdAKCM7VkhSvrBNkI+/E7MZtq2YTY08ACgvwYI
9XDt+0aaIZr/keNomxrnrqg=
=dMhp
-----END PGP SIGNATURE-----