<br><br><div class="gmail_quote">On Tue, Nov 25, 2008 at 8:26 AM, Ted Kremenek <span dir="ltr"><<a href="mailto:kremenek@apple.com">kremenek@apple.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="border-left: 1px solid rgb(204, 204, 204); margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex;">
<div style=""><div class="Ih2E3d"><br><div><div>On Nov 24, 2008, at 3:47 PM, Zhongxing Xu wrote:</div><br><blockquote type="cite"><span style="border-collapse: separate; color: rgb(0, 0, 0); font-family: Helvetica; font-size: 14px; font-style: normal; font-variant: normal; font-weight: normal; letter-spacing: normal; line-height: normal; text-indent: 0px; text-transform: none; white-space: normal; word-spacing: 0px;"><br>
On Tue, Nov 25, 2008 at 2:58 AM, Ted Kremenek<span> </span><span dir="ltr"><<a href="mailto:kremenek@apple.com" target="_blank">kremenek@apple.com</a>></span><span> </span>wrote:<br><blockquote class="gmail_quote" style="border-left: 1px solid rgb(204, 204, 204); margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex;">
Hi Zhongxing,<br><br>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.</blockquote>
<div><br>Okay. But are these utility methods self-documented?<br> </div></span></blockquote></div><br></div><div>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.</div>
</div></blockquote></div><br>I see.<br>