On 01/24/2011 02:02 AM, Paul A. Bristow wrote:
... elision by patrick... So I feel we need to encourage library authors to produce:
1 PDF version as well as HTML (and so use Quickbook?).
2 Quickbook and Doxygen reference section.
2 Doxygen comments in C++ code about everything. (Perhaps GSoC or Boost.Guild people could volunteer to do this?).
3 Auto-indexing of functions.,classes ... as standard. (So we need to get auto-index into next Boost release package).
4 Conventional word index - Indexing of words in the text.
5 A user-friendly Quickbook template so new authors can get going quickly.
(I don't feel I am alone in finding that it's pretty hard going getting setting up all the tools in place, jamfiles, correct links to tools and headers. Moving the code messes some 'would-be' relative address in jamfiles. Getting locations of images users graphs, equations, logos, admonitions, navigations, png versus svg images etc have caused me grief. The requirement to use only relative addressing means that there are loads of copies of image files bloating the file system. And to produce a packable html requires installing images and style sheet(s)).
What a wonderful email. I would volunteer to put Doxygen comments in C++ code for someone. It seems like we not only need a user-friendly Quickbook template, but a good tutorial document from someone that's fought through this and has found success. Patrick