Changes between Version 1 and Version 2 of Guidelines/DoxygenGuidelines


Ignore:
Timestamp:
Apr 15, 2011, 5:27:02 PM (8 years ago)
Author:
viboes
Comment:

Updated Doxygen Limitations and guidelines

Legend:

Unmodified
Added
Removed
Modified
  • Guidelines/DoxygenGuidelines

    v1 v2  
    88
    99-----------------------------------------------------------------------------------------------
    10 = Limitations =
    11 
    12 
    13 -----------------------------------------------------------------------------------------------
    14 == doxygen tags not supported ==
    15 
    16 Currently there are some doxygen tags that are not taken in account by BoostBook.
    17 
    18 -----------------------------------------------------------------------------------------------
    19 === @tparam ===
    20 
    21 -----------------------------------------------------------------------------------------------
    22 === @see ===
     10= Doxygen Limitations =
    2311
    2412-----------------------------------------------------------------------------------------------
     
    7765
    7866
     67-----------------------------------------------------------------------------------------------
     68= !BoostBook Limitations =
     69
     70-----------------------------------------------------------------------------------------------
     71== doxygen tags not supported ==
     72
     73Currently there are some doxygen tags that are not taken in account by BoostBook.
     74
     75-----------------------------------------------------------------------------------------------
     76=== @tparam ===
     77
     78-----------------------------------------------------------------------------------------------
     79=== @see ===
     80
    7981
    8082-----------------------------------------------------------------------------------------------
     
    124126Doxygen provides a certain number of tags that allows to generate a clean documentation, but it would be great if all the Boost libraries document its Reference section following the C++ standard style.
    125127
     128-----------------------------------------------------------------------------------------------
     129== Documenting typedefs ==
    126130
     131When the brief comment takes only one line the comment is included on the Synopsis and nothing on the description section
     132
     133{{{
     134//! the underlying type
     135typedef UT underlying_type;
     136}}}
     137
     138generates
     139
     140{{{
     141typedef UT underlying_type; // the underlying type
     142}}}
     143
     144
     145Steven Watanabe said: "This can be controlled by the !BoostBook parameter, boost.compact.typedef."
     146
     147-----------------------------------------------------------------------------------------------
     148== Generating only one HTML page for the whole Reference  ==
     149
     150Steven Watanabe said: "You can use onehtml to generate a single html page. But I don't think this is as well tested as chunking though. I believe that the docbook stylesheets have a bunch of options that allow you to control chunking, too."
     151
     152
     153
     154