> I agree that the Doxygen->BoostBook XSLT probably won't create complete > BoostBook documentation. Overview documentation, tutorials, FAQs, etc. I > would expect to be written directly in BoostBook (DocBook, really); Doxygen > XML and the resulting BoostBook would be responsible for everything in the > <libraryreference> tag, e.g., the documentation of headers, classes, > functions, etc. So my disagreement is that I do not believe we should be able > to include docs for a single class at an arbitrary place in the > documentation. I think that documentation of _all_ types/functions for a > library should stay in one place, so we have a complete reference section for > each library.
Yes, but even if we restrict the generated output to the reference section, I agree with Vladimir that we need to be able to exclude some things. That is, we might have some detail classes that we don't want picked up in the docs. But I think we can control this by using build processes and config settings. > Part of the reason for my pickiness is that I'm trying to give the BoostBook > reference material the same "feel" as the C++ standard. I plan to provide > options in the stylesheets to select a specific set of libraries for > transformation and to process only reference documentation. So, for instance, > a user could say "build a PDF of the reference documentation for Function and > Bind", perhaps with a bjam invocation such as: > bjam pdf -sLIBRARIES="function bind" -sSECTIONS="reference" > > By forcing developers to keep the reference material together, it forces them > (err, us) to keep the reference material consistent. My dream would be that > we could generate library proposals with just a few switches passed to the > XSL stylesheets :) Gee ,I hope you don't think this is a 'far-off dream' because I'm intending on doing just that! Jeff ------------------------------------------------------- This SF.NET email is sponsored by: SourceForge Enterprise Edition + IBM + LinuxWorld = Something 2 See! http://www.vasoftware.com _______________________________________________ Boost-docs mailing list [EMAIL PROTECTED] Unsubscribe and other administrative requests: https://lists.sourceforge.net/lists/listinfo/boost-docs
