On Wed, 2009-08-05 at 12:30 +0100, John-Mark Bell wrote:
> Precis:
> 
> This is round 3 of Bo Yang's libdom core changes.

This is mostly fine. There are a number of instances of odd whitespace
changes, that seem to be the result of s/    /\t/g across the source
tree. I highlighted some of these in round 2 and they don't appear to
have been fixed.

Please ensure all parameter documentation in doxygen comments look like:

/**
 * This is a function description.
 *
 * \param a       This is parameter 1.
 * \param param2  This is parameter 2. It has a long description that
 *                requires wrapping to fit within 80 columns.
 * \return DOM_NO_ERR            on success,
 *         DOM_<something else>  on failure.
 */

That is, all parameter documentation is aligned at the column 2 spaces
after the longest name. 

Return code documentation may be on a single line, if it will fit.
Otherwise, wrap it as shown.

There should be no tab characters within comments.

There are quite a few cases where lines do not fit within 80 columns.
These should be fixed.

Please check comments for spelling. There are a number of typos that
should be fixed.


J.


Reply via email to