On Tue, Nov 25, 2008 at 8:26 AM, Ted Kremenek <[EMAIL PROTECTED]> wrote:
> > On Nov 24, 2008, at 3:47 PM, Zhongxing Xu wrote: > > > On Tue, Nov 25, 2008 at 2:58 AM, Ted Kremenek <[EMAIL PROTECTED]> wrote: > >> Hi Zhongxing, >> >> Looks great. One thing we should start doing is better documenting these >> utility methods with doxygen comments. We have a bunch of variants now of >> methods like 'MakeVal', so it's probably worth investing some time in >> providing some documentation as we add these methods. > > > Okay. But are these utility methods self-documented? > > > > That's a fair point. We probably should document at least the principal > utility method in a family of methods and for ones that vary by an (obvious) > argument difference we can probably omit the documentation. Ideally > everything should be documented; it's just clean and makes everything > explicit. > I see.
_______________________________________________ cfe-commits mailing list [email protected] http://lists.cs.uiuc.edu/mailman/listinfo/cfe-commits
