>> At some point we really should feed back our results to the Doxygen >> development group. Maybe we can get them to fix the XML output and >> make it a bit more friendly for boost-book conversion. Of course >>I'll help when we get a bit further... > >I've started putting some comments on the Wiki: >http://www.crystalclearsoftware.com/cgi-bin/boost_wiki/wiki.plBoost_Documentation_Format/Tasks > >As I run into more trouble I'll add comments to that list.
Sounds good. >> Also, after studying this in detail have you had any more thoughts >> about things that might be missing from boost-book? As I said before, I think >> the wrapping the loose <para> tags in a description tag something like >> the <detaileddescription> would be a useful addition just to clearly >> delineate what these elements represent. > >Yes, I agree with this. Let's call it <description> (we have ><purpose> for the brief description in several places already). Works for me. >> And I've been assuming that >> given boost-book goals we aren't really interested in things like >> <inheritancegraph>, <collaborationgraph>, <incdepgraph> >> (include dependency graph), and <programlisting>. > >We wouldn't want to use any of the graphs from the Doxygen output >anyway, because it wouldn't include other entities in BoostBook >that didn't come from Doxygen. Besides, most of those are very >easy to generate from within the XSL stylesheets. Just to make sure you didn't misunderstand, I'm not talking about the generated graphs, these are xml data that represent the 'inheritence graph', etc. I'm doing this from memory so please correct me, but I don't recall a way to represent a 'tree of includes' in boost-book reference specification. >I don't know what to do about <programlisting> yet, >though... Well I don't think we have to do anything with it. The reason it is there is to provide for 'enhanced' source browsing. Specifically you can do nice things like hyperlink from the reference documentation to the exact source line. As an example you can look at the example below. Pay special attention to the hyperlinks http://www.crystalclearsoftware.com/libraries/gdtl/gdtl_ref_guide/date_8hpp- source.html One interesting use of it would be to automatically cross-reference example files (which would wind up as a stand alone html page) that could be referenced from various points in the reference -- sort of an automatic TOC of examples that reference a particular class. But I see this as something that we could do in version 2... 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
