-----Original Message----- From: boost-bounces@lists.boost.org [mailto:boost-bounces@lists.boost.org] On Behalf Of Barend Gehrels Sent: Monday, January 24, 2011 11:17 PM To: boost@lists.boost.org; boost-docs@lists.boost.org Subject: Re: [boost] Review request: auto-index tool
Hi,
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.
To the useful list of Paul I would suggest that there should be many more examples within the boost docs. So:
6: Enough clear examples
+1 - at least !
We struggled too with generating the docs.
Reassured to hear that ;-)
This produces things as in: http://bit.ly/gJSmaa
But the results are worth it :-) However you haven't commented on the conventional word-in-the-text index ? Do you note feel a need for this? Did you try John's auto-index and reject it? Paul --- Paul A. Bristow, Prizet Farmhouse, Kendal LA8 8AB UK +44 1539 561830 07714330204 pbristow@hetp.u-net.com