On Tue, 24 Jun 2003, Pavol Droba wrote:
> Now I'm getting to the real problem. I would like to document layer 2 in detail and 
> layer 1 only as a reference.
> Together there is more than "150" functions to be documented. There are almost no 
> classes worth noticing just functions.
> It is almost impossible to copy them into HTML and keep in sync with the code.
>
> I have tried Doxygen to generate a documentation, but the results were very 
> unpleasant. Probably due to templated natute of
> the whole lib, result was not very nice and readable.
> I was following the discussion about BoostBook a little bit, and it seems to me that 
> it could be used for this documentation.
> I have seen in the archives of this list that it is possible to generate a part of 
> documentation using doxygen and then
> integrate it with BoostBook.
> However, I don't really know where to start. I have no experience with DocBook at 
> all.
>
> I would be very greatful if somebody could help me started or at least give me some 
> hints how to.
> Also any general-purpose documentation writing hints could be very helpful.

There is some documentation on using Doxygen with BoostBook here:
  http://www.cs.rpi.edu/~gregod/boost/tools/boostbook/doc/html/

However, there's one major change that isn't covered in that version of
the documentation: you do not need to get Doxygen from CVS or my
monolithic XML patch. Just about any recent version of Doxygen (at least,
one that spits out well-formed XML) will work.

The Doxygen -> BoostBook conversion is nowhere near perfect, but we're
working on it. The more testcases we have, the better it can get :)

        Doug



-------------------------------------------------------
This SF.Net email is sponsored by: INetU
Attention Web Developers & Consultants: Become An INetU Hosting Partner.
Refer Dedicated Servers. We Manage Them. You Get 10% Monthly Commission!
INetU Dedicated Managed Hosting http://www.inetu.net/partner/index.php
_______________________________________________
Boost-docs mailing list
[EMAIL PROTECTED]
Unsubscribe and other administrative requests: 
https://lists.sourceforge.net/lists/listinfo/boost-docs

Reply via email to