On Aug 23, 2004, at 4:20 PM, Eric Niebler wrote:
http://boost-sandbox.sourceforge.net/libs/xpressive/doc/html/ regex_match.html

The returns clause is:
true if a match is found, false otherwise

but it doesn't get a "Returns:" header. And the list of preconditions is just dumped into the Description section instead of getting its own "Preconditions" header. Do you see what I mean?

Yep, that looks broken.

For reference, the doc comments that generated this documentation are:

/// \brief See if a regex matches a sequence from beginning to end.
///
/// Determines whether there is an exact match between the regular expression re,
/// and all of the sequence [begin, end).
///
/// \pre Types BidiIterT and OtherBidiIterT meet the requirements of a Bidirectional Iterator (24.1.4).
/// \pre OtherBidiIterT is convertible to BidiIterT.
/// \pre re.empty() == false
/// \pre [begin,end) denotes a valid iterator range.
/// \param begin The beginning of the sequence.
/// \param end The end of the sequence.
/// \param what The match_results struct into which the sub_matches will be written
/// \param re The regular expression object to use
/// \param flags Optional match flags, used to control how the expression is matched against the sequence. (See match_flag_type.)
/// \return true if a match is found, false otherwise
/// \throw regex_error on stack exhaustion

Hmmm, dropping these markup onto a function formats properly for me, with the appropriate "Requires" and "Returns" headers. If you've a current CVS checkout and are still getting problems, could you send me (privately) the .doxygen file that is getting generated? I'm wondering if Doxygen is doing something odd.


        Doug



-------------------------------------------------------
SF.Net email is sponsored by Shop4tech.com-Lowest price on Blank Media
100pk Sonic DVD-R 4x for only $29 -100pk Sonic DVD+R for only $33
Save 50% off Retail on Ink & Toner - Free Shipping and Free Gift.
http://www.shop4tech.com/z/Inkjet_Cartridges/9_108_r285
_______________________________________________
Boost-docs mailing list
[EMAIL PROTECTED]
Unsubscribe and other administrative requests: 
https://lists.sourceforge.net/lists/listinfo/boost-docs

Reply via email to