[v3] doxygen cleanups

View: New views
1 Messages — Rating Filter:   Alert me  

[v3] doxygen cleanups

by Benjamin Kosnik :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message


This is a collection of fixes for the doxygen markup that generates the
API web pages.

Adds markup for iterator classes.

Work around for doxygen parse odditiy WRT C++0x traits classes:

include/std/type_traits
: public integral_constant<bool, _Tp(-1) < _Tp(0)>
to
: public integral_constant<bool, static_cast<bool>(_Tp(-1) <_Tp(0))>

Work around for doxygen parse oddity WRT shared_ptr, split into
shared_ptr.h and shared_ptr_base.h, adjust markup.

Fixed various errors markup, noticed while working on above issues.
  - escape #
  - use single quote instead of double quote (or else use ")
  - @__c to @c, @__f to @f

This last exposed some issues with the formula markup in

include/parallel/list_partition.h

Where:

   *  partitions will differ in at most @__f$ \sqrt{\mathrm{__end} -
   *  \mathrm{__begin}} @__f$ __elements. Otherwise, the ratio between
     the
   *  longest and the shortest part is bounded by @__f$
   *  1/(\mathrm{__oversampling} \cdot \mathrm{num\_parts}) @__f$.
   *  @return Length of the whole sequence.
 
hangs doxygen. I my tex-fu is not strong enough on  to figure this out,
(and really I was only doing this on the way somewhere else)  but the
resident expert can work it out?

tested x86_86/linux

-benjamin

20091106-1.patch.bz2 (31K) Download Attachment