Doug Gregor wrote:
On Aug 23, 2004, at 11:59 AM, Eric Niebler wrote:
I'm still not getting section headers for any of these.
I think I don't quite understand what you mean by this. Where do you expect to see section headers?
Have a look at:
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?
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
I've noticed a recent change. The HTML file names for the documentation of free functions used to be meaningless id numbers, but now they are the names of the functions they contain. That's good, except for 2 things:
1) The name is not fully qualified, so there could be conflicts if the same function (eg. swap) exists in two different namespaces. How about something like function.boost.<libname>.<namespace>.swap.html?
Actually, it will only use the function name when there is a unique entity with that name. Otherwise, it'll fall back to the old id.
OK, cool.
2) The function-name-as-file-name thing doesn't work so well when the function is an operator. I now have operator<<.html, and none of the links to it will reach it. :(
Oops, I'll fix that in a few moments.
Thanks!
-- Eric Niebler Boost Consulting www.boost-consulting.com
------------------------------------------------------- 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
