On Tue, 24 Jun 2003 17:25:23 -0400, David Abrahams wrote > Pavol Droba <[EMAIL PROTECTED]> writes: > > > 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. > > Synopsis works great on templates. > > http://article.gmane.org/gmane.comp.lib.boost.documentation/119
There are a few problems here. If you haven't written any comments in the code to support Doxygen or Synopsis, you won't be able to get useful results. Also if you adopt Boost Book even if you use Doxygen you will get results that are not much like the 'out of the box Doxygen' results. In my experience the problem with Doxygen and templates is not so much the parsing of the templates as Dave suggests below, but rather splitting and refining down the output in a logical structure as you suggest in your mail. The easy thing is to run all the code. The hard thing is to actully document the components in the code and split things into logical groups. > > 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. > > If doxygen is having problems parsing your templates to begin with, > BoostBook can't help. If it's just formatting, you might get > somewhere this way. Agreed. No matter what I would recommend looking into BoostBook. Doug has done a nice job on this... Jeff ------------------------------------------------------- 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
