RE: DOCBOOK-APPS: "Abbreviated" DocBook (notice about doxygen)

["Prikryl,Petr" <PRIKRYLP@skil.cz>]

Hi,

This is a notice about relation between DocBook and the doxygen
tool, which was mentioned in this thread as the alternative
to manual including (probably) DocBook-like tags
inside C/C++ sources.

I am using Doxygen (or doxygen) for a while.  I guess that it
probably does that you want (generating the documentation
for C/C++/Java/IDL code).

The below mentioned links are not dead!  All of them work 
for me. The last public release of doxygen (1.2.13.1) was 
released in January 5, 2002 (so quite fresh, isn't it?).

Being one of the contributors to the development (not directly
working on XML part), I can tell
you that it generates XML as one of its output.  It is currently
really experimental part of doxygen and others work hard
on that.  As far as I know, the XML output will probably become
a kind of intermediate (internal) form of the generated results.
It is primarily tailored to capture details generated by doxygen.
Then, the set of generators then will produce final output
formats.

There definitely are people among doxygen users who would
like to see DocBook XML as one of the final output form.
This is not the case, yet.  It would be nice to attract some
of the DocBook experts to doxygen development to accelerate
the DocBook XML generator development.

These days, doxygen produces the following final outputs:
HTML, LaTeX sources, RTF, man, and the mentioned XML
with the generated texts in one of the 25 human languages.

I personally appreciate that the doxygen comments inside
my C++ sources are really brief and intuitive in syntax.
They fit to programmer's need -- no need to learn details
of documentation systems.  Still, doxygen produces nice,
highly configurable output with automatically generated
hyperlinks (if applicable), and with automatically generated
images (clickable in HTML) that capture dependencies
and relations inside your developed system.

Hope this helps,

 Petr
---
Petr Prikryl, Skil, spol. s r.o., (prikrylp@skil.cz)


> -----Original Message-----
> From:	David Cramer [SMTP:david_cramer@broadjump.com]
> Sent:	Thursday, January 10, 2002 6:28 AM
> To:	Kevin Atkinson; docbook-apps@lists.oasis-open.org
> Subject:	RE: DOCBOOK-APPS: "Abbreviated" DocBook
> 
> I haven't played with the feature so I don't know for certain if it
> would work for you, but the automatic documentation tool Doxygen has xml
> as one of it's output types. You could write an xslt  to convert that
> output to whatever you need. 
> 
> This is (or perhaps was) the link
> <http://www.stack.nl/~dimitri/doxygen/>. It's cold right now. 
> http://freshmeat.net/projects/doxygen/ lists http://www.doxygen.org/ as
> the homepage, but that's dead too now. Perhaps they're moving or
> something--it's a mature tool with a strong community supporting it. 
> 
> In other situations I've found it best to write a simple dtd (e.g. one
> describing tables and columns in a database) and xsl that to docbook. If
> you're careful to avoid naming any elements the same as docbook elements
> (with a namespace), then you can include the entire docbook dtd in your
> dtd. Its modular design makes it easy to pick and choose what parts you
> want.
> 
> David
> 
> -----Original Message-----
> From: Kevin Atkinson [mailto:kevin@atkinson.dhs.org]
> Sent: Wednesday, January 09, 2002 10:47 PM
> To: docbook-apps@lists.oasis-open.org
> Subject: DOCBOOK-APPS: "Abbreviated" DocBook
> 
> 
> document becomes rather difficult.  So, I was wondering if there exists
> any tools which will allow me to enter in documents in a more terse and
> human readable form with the minimal amount of tags and then have it
> expand it into full DocBook form with all the special purpose tags in
> place. For example I would like to be able to enter this: