> 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.
Fair enough. Then, bearing in mind that this is going to be viewed as external documentation (and thus the viewer wouldn't necessarily have the benefit of being able to see what it does internally), I personally would put something like Returns the result of calling F2(). This then allows them to view F2's documentation in turn, to see what THAT does - they can follow the chain to find what they need to know. -- Jason Teagle [EMAIL PROTECTED] _______________________________________________ msvc mailing list [email protected] See http://beginthread.com/mailman/listinfo/msvc_beginthread.com for subscription changes, and list archive.
