Hi > The return value has to be documented per our coding standards and the > project contract (what we agreed we would provide to those paying us). > In this case, I am changing (and improving) regular comments to doxygen > comments (http://www.doxygen.org), which will be used to produce > documentation of the code which will be delivered to our customer. > There is no choice about whether to comment it or not.
Ok, in that case you should consider the function to be a black box and state what the return value means. The fact that F1() returns F2() is an implementation detail and could change at anytime. Regards Paul Paul Grenyer email: [EMAIL PROTECTED] web: http://www.paulgrenyer.co.uk Aeryn: http://www.aeryn.co.uk Metal. Is there anything else? _______________________________________________ msvc mailing list [email protected] See http://beginthread.com/mailman/listinfo/msvc_beginthread.com for subscription changes, and list archive.
