On Tue, Jun 24, 2003 at 05:04:29PM -0400, Douglas Paul Gregor wrote:
> 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


I have tried to generate boostdoc from doxygen, but I'm getting strange errors
when running bjam.

Error:

D:\Projects\Boost\boost\libs\string_algo\doc>bjam --v2
D:/Projects/Boost/boost/tools/build/tools\doxygen.jam:21: in load
rule type.register unknown in module doxygen.
D:\Projects\Boost\boost\tools\build\kernel\modules.jam:296: in import
Jamfile.v2:3: in modules.load
D:/Projects/Boost/boost/tools/build/new\project.jam:285: in load-jamfile
D:/Projects/Boost/boost/tools/build/new\project.jam:69: in project.load
D:/Projects/Boost/boost/tools/build\build-system.jam:74: in load
D:\Projects\Boost\boost\tools\build\kernel\modules.jam:296: in import
D:\Projects\Boost\boost\tools\build\kernel\bootstrap.jam:122: in boost-build
D:\Projects\Boost\boost\boost-build.jam:12: in module scope


<Jamfile.v2>
project libs/string_algo/doc ;
import boostbook : boostbook ; 
import doxygen : doxygen ;

doxygen find.doxygen : ../../../boost/string_algo/find.hpp ;
boostbook find : fing.doxygen ;
</Jamfile>

<user-config.jam>
import toolset : using ;


#  xsltproc (from libxslt) configuration
using xsltproc ;

#  BoostBook configuration
#  using boostbook ;
using boostbook : d:\DocBook\xsl
                                : d:\DocBook\dtd
                                ;

using doxygen ;
</user-config.jam>

I'm using CVS version of boost under cygwin.

What am I doing wrong?


-------------------------------------------------------
This SF.Net email sponsored by: Free pre-built ASP.NET sites including
Data Reports, E-commerce, Portals, and Forums are available now.
Download today and enter to win an XBOX or Visual Studio .NET.
http://aspnet.click-url.com/go/psa00100006ave/direct;at.asp_061203_01/01
_______________________________________________
Boost-docs mailing list
[EMAIL PROTECTED]
Unsubscribe and other administrative requests: 
https://lists.sourceforge.net/lists/listinfo/boost-docs

Reply via email to