"Jonathan Turkanis" <technews@kangaroologic.com> writes:
David Abrahams wrote:
"Jonathan Turkanis" <technews@kangaroologic.com> writes:
I have exactly the same situation in Iostreams. I give each function its own page of documentation, with tables demonstrating how the semantics depends on the properties of the template parameters. For example:
www.boost.org/libs/iostreams/doc/?page=functions/read.html%23reference
not bad. A nit:
The semantics of read depends on the category of T as follows ^ ^ "semantics" is plural, so drop the "s" here.
Are you sure? I'd say it's a mass noun.
What's a mass noun? e.g., "Water?" http://dictionary.reference.com/search?q=semantics seems to indicate it could go either way, if I am reading it correctly. Oh, well. Sorry to bother you. I guess it would read more easily if you'd replace "semantics" with "effect." -- Dave Abrahams Boost Consulting www.boost-consulting.com