> DocBook has been promoted as the standard for documentation for software
> projects. Checkout the Linux-HOWTO HOWTO on this. There is a pretty good
> documentation writer I think..., pgsgml?, something like that. I haven't
> written any in a while, but it's pretty easy to convert into HTML
Micah Dowty wrote:
>
> I'm about to start the documentation, first a tutorial/reference on client-side
>programming. (Yes, I've said this before but now I'm serious :)
>
> Just wondering if anybody has any preferences on what format it's in. I had been
>assuming I'd do it in HTML. But, I'd rea
I have considered both Docbook SGML and Doxygen. I have decided (at least for the
client API) to use Doxygen. I think it is better suited for documenting APIs and C
code than Docbook, and after seeing what it is capable of I like the integration of
documentation and code.
Doxygen can generate
On Sunday 13 May 2001 20:41, Micah Dowty wrote:
> I'm about to start the documentation, first a tutorial/reference on
> client-side programming. (Yes, I've said this before but now I'm serious :)
>
> Just wondering if anybody has any preferences on what format it's in. I had
> been assuming I'd do
> what about sgml?
> I saw some packages distributing sgml and the make file generates HTML,
> Text, TeX and others from it.
From my rather short experience, docbook is quite complete for documenting
global ideas, but rather cumbersome if you want to describe the API very
precisely by hand. There
what about sgml?
I saw some packages distributing sgml and the make file generates HTML,
Text, TeX and others from it.
-debugger
- Original Message -
From: Micah Dowty <[EMAIL PROTECTED]>
To: <[EMAIL PROTECTED]>
Sent: Monday, May 14, 2001 8:41 AM
Subject: [Pgui-devel] Preferred documenta
