[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: Doxygen patch
From: |
Satya |
Subject: |
Re: Doxygen patch |
Date: |
Wed, 13 Sep 2006 13:29:34 -0500 |
Frans,
Thanks for the comments. I have just *changed the comment style* and not
touched any other parts of the comments themselves. So, capitalization
inconsistancies etc and white spaces at end of lines were already there to
begin with; I think I will fish them out when I have time;
Yes, special characters are a problem. I will have to check how many
others have escaped my attention.
thanks,
--satya.
And, yes, I will have to run this thru doxygen yet.
Some comments:
* It's redundant to specify the file name when the @file tag is in the
file
being documented. For example, in assoc.h, just write "\file" instead
of "\file assoc.h". This makes the code less error-prone, for example.
* There is editorial inconsistency. Some sentences start with a
capitalized
character. Some do not. Some sentences end with a period. Some do not. I
would use proper sentences throughout. This seems to be here and there in
the
file.
* Some lines ends with whitespace. Search and remove.
* Have you checked the doxygen output for warnings? For example,
for "%include" isn't "%include" put in the output, but "include" because
"%"
has special interpretation. You probably want %%include. There's some
other
case with % too.