Deane Yang wrote:
Eric Niebler wrote:
Once again, the "before":
http://tinyurl.com/ho2a3
and the "after":
http://tinyurl.com/fh43h
Others are welcome to jump into this discussion at any time. :-)
I don't have any useful suggestions, but I find both versions visually
confusing, because, despite the capitalization, the "Requires",
"Returns", and "Throws" look too much like they're part of the
Parameters list.
An extremely minor quibble is that I would also prefer that "Requires"
be replaced by "Requirements".
Maybe (but I'm not sure) "Requires", "Returns", and "Throws" should be
at the same level as "Parameters"?
I tend to agree. Is this better?
http://tinyurl.com/j4y4s
It uses a nested table. Are there browsers out there that don't handle
that? Looks OK with Firefox and IE6.
Maybe "Requires" should really be "Preconditions". After all, we already
have "Postconditions".
--
Eric Niebler
Boost Consulting
www.boost-consulting.com
-------------------------------------------------------
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
