[osiris-devel] 3.0.4-current development documentation?

[Alexei Roudnev]

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

----- Original Message ----- 
From: "Thomas Jones" <thomas.jones at linux-howtos.com>
To: "Osiris Developers" <osiris-devel at lists.shmoo.com>
Sent: Saturday, February 21, 2004 2:13 PM
Subject: [osiris-devel] 3.0.4-current development documentation?


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

Hello all,

Has someone already generated the proper documentation for the Osiris system
development?

I didn't notice it on the website; so I went ahead and generated the
appropriate documentation in the following formats:

- - html
- - latex
- - xml
- - pdf

Does anyone want a copy of these? BTW.....I changed the comment structure of
all struct's to the JavaDoc specification. Is this a problem, Brian? It
would
be alot more efficient to change the source headers so as to be easily
recognizable during generation. Is that ok?

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

iD8DBQFAN9gDQT2komo99ukRAlmsAKDKLG3cMZmJvRzuk8Raa+Fwj9scvwCfYqZy
LchVquyal7wEL3HWurPebWg=
=hG6T
-----END PGP SIGNATURE-----

_______________________________________________
osiris-devel mailing list
osiris-devel at lists.shmoo.com
https://lists.shmoo.com/mailman/listinfo/osiris-devel