Re: [boost] [circular_buffer] New version of documentation

Subject: Re: [boost] [circular_buffer] New version of documentation
From: Paul A. Bristow (pbristow_at_[hidden])
Date: 2013-06-06 09:37:20

> -----Original Message-----
> From: Boost [mailto:boost-bounces_at_[hidden]] On Behalf Of Paul A. Bristow
> Sent: Wednesday, May 29, 2013 5:11 PM
> To: boost_at_[hidden]
> Subject: Re: [boost] [circular_buffer] New version of documentation
> 
> > -----Original Message-----
> > From: Boost [mailto:boost-bounces_at_[hidden]] On Behalf Of
> > Marshall Clow
> > Sent: Thursday, May 23, 2013 8:01 PM
> > To: boost_at_[hidden]
> > Subject: Re: [boost] [circular_buffer] Volunteer(s) needed

> I have updated my new  Quickbook, Doxygen, Autoindex version from the existing documentation  for
> Boost.Circular_Buffer at
> 
> https://svn.boost.org/svn/boost/trunk/libs/circular_buffer/doc/circular_buffer.html
> 
> I have made few substantive changes to the text, mainly adding more hyperlinks, (and correcting
some
> that were wrong of missing - using the inspect tool is a really, really good
> idea!)
> 
> So that users can comment on this new version, I have put html and pdf versions in my Dropbox.

I have now corrected some mistakes.
> 
> The latest pdf version is at

https://dl.dropboxusercontent.com/u/43940943/doc/circular_buffer.pdf

> which can of course be viewed by any PDF reader

(I have recently moved to using Foxit instead of Adobe Reader).

> The html Quickbook version is from folder (libs/circular_buffer/doc/html)  is at

https://dl.dropboxusercontent.com/u/43940943/doc/html/index.html
 
> This library uses the full automatic indexing of C++ names and hyperlinking to and from the text.
> 
> The header files have the classes and functions fully documented in Doxygen format, and this is
used to
> create the C++ reference sections:

https://dl.dropboxusercontent.com/u/43940943/doc/html/boost_circular_buffer_c___reference.html

> so that you can see what the classes do and the parameters, template parameters, returns etc for
the
> functions.
> I believe that these details are essential for Really Useful documentation.
> 
> The original Doxygen standalone (whose format some users prefer) is at

https://dl.dropboxusercontent.com/u/43940943/doc/doxygen/html/index.html 

> So you can see the pros and cons of the same information displayed side by side in different
formats.

> The PDF and HTML versions also has an index at the end (this could be improved as it only gives
C++
> functions etc at present).

Unless someone squeaks, I proposed to commit the existing docs with this new version in a week or
so.

At this time, I will need to update the header files which have new comments (but, unless my fat
finger strike again, no changes to the actual code).

The tests run OK with these files locally.

I will leave the existing docs in place, but change the doc/index.html to redirect to the new
version.

This will mean that the new version will become 'standard' for the next release.

Paul

---
Paul A. Bristow,
Prizet Farmhouse, Kendal LA8 8AB  UK
[phone]  07714330204
pbristow_at_[hidden]