<html><body style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space; "><br><div><div>On Nov 24, 2008, at 3:47 PM, Zhongxing Xu wrote:</div><br class="Apple-interchange-newline"><blockquote type="cite"><span class="Apple-style-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; orphans: 2; text-align: auto; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-border-horizontal-spacing: 0px; -webkit-border-vertical-spacing: 0px; -webkit-text-decorations-in-effect: none; -webkit-text-size-adjust: auto; -webkit-text-stroke-width: 0; "><br class="Apple-interchange-newline">On Tue, Nov 25, 2008 at 2:58 AM, Ted Kremenek<span class="Apple-converted-space"> </span><span dir="ltr"><<a href="mailto:kremenek@apple.com">kremenek@apple.com</a>></span><span class="Apple-converted-space"> </span>wrote:<br><blockquote class="gmail_quote" style="border-left-width: 1px; border-left-style: solid; border-left-color: rgb(204, 204, 204); margin-top: 0pt; margin-right: 0pt; margin-bottom: 0pt; margin-left: 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>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></body></html>