David Abrahams wrote:
"Eric Niebler" <[EMAIL PROTECTED]> writes:
IMO, class references are hard to read because there is no clear
separation between the documentation for different member
functions.
The standard indents the function signature, which helps.
As an experiment, I've divided member functions with a
subtle horizontal rule.
Before:
http://tinyurl.com/jkxol
After:
http://tinyurl.com/j78g2
Nicer, but why do we have numbers in the first place? Are those like
paragraph numbers in the standard?
To be honest, I prefer the one without the horizontal rule.
IMO, the number and indentation of the items themselves
already clearly separate each member.
I remember Dave questioning my use of blank comment separators
like:
/////////////////////////////////////////////////////////////
I was thinking that Dave would have questioned the use of HRs
here too as I think they are the same. I do not use blank
comment separators anymore.
Cheers,
--
Joel de Guzman
http://www.boost-consulting.com
http://spirit.sf.net
-------------------------------------------------------
This SF.Net email is sponsored by xPML, a groundbreaking scripting language
that extends applications into web and mobile media. Attend the live webcast
and join the prime developer group breaking into this new coding territory!
http://sel.as-us.falkag.net/sel?cmd=lnk&kid=110944&bid=241720&dat=121642
_______________________________________________
Boost-docs mailing list
[email protected]
Unsubscribe and other administrative requests:
https://lists.sourceforge.net/lists/listinfo/boost-docs
