On Oct 14, 2011, at 9:17 AM, Ted Kremenek wrote: > I don't really understand your comments. > > The doxygen comments only have value for generating documentation when they > are paired with the actual things they are documenting. Having a bunch of > comments that look like they are documenting non-existent members looks like > turds in the code to me.
They are, in fact, documenting logical fields in the class; it's just that those fields are manually laid out and so cannot be declared in C++. That manual layout makes it pretty imperative that there be documentation next to the rest of the fields explaining what's going on. Making the comments non-doxygen by dropping down to two slashes would be reasonable, but please don't move the comments away completely. John. _______________________________________________ cfe-commits mailing list [email protected] http://lists.cs.uiuc.edu/mailman/listinfo/cfe-commits
