[cfe-commits] r59956 - in /cfe/trunk: include/clang/Analysis/PathSensitive/SVals.h lib/Analysis/SVals.cpp

[Ted Kremenek]

On Nov 24, 2008, at 3:47 PM, Zhongxing Xu wrote:

>
> On Tue, Nov 25, 2008 at 2:58 AM, Ted Kremenek <kremenek at apple.com>  
> 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.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.llvm.org/pipermail/cfe-commits/attachments/20081124/824c8244/attachment.html>