<div class="gmail_quote">On Sat, Dec 12, 2009 at 10:23 AM, David Doria <span dir="ltr"><<a href="mailto:daviddoria%2Bvtk@gmail.com">daviddoria+vtk@gmail.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex;">
<div class="im">On Sat, Dec 12, 2009 at 10:17 AM, Francois Bertel<br>
<<a href="mailto:francois.bertel@kitware.com">francois.bertel@kitware.com</a>> wrote:<br>
> Arguments of functions and methods in VTK start with lowercase. So<br>
> it's is not OK. Only the variable member of a class start with an<br>
> upper case.<br>
<br>
</div>It seems very annoying to not comply with mathematics notation, which<br>
is clearly more standard than VTK notation.<br>
<div><div></div><div class="h5"><br>
</div></div></blockquote><div>The mathematical notation is there to make it clear that the variable in the formula is a matrix, this is C++ code in a matrix class, which already makes it clear that these variables are concerned with matrix algebra. </div>
<div><br></div><div>It is fine in the comments to use conventional mathematical notation, but I agree with Francois that the code should stick to VTK coding conventions wherever possible. Having comments inside of a //BTX //ETX block does not present any issues.</div>
<div><br></div><div>I think the comments are a little on the verbose side, I would rather go into detail about how the matrix is laid out in memory in the class description, and then the individual function documentation can be much briefer. So explain row major order, assume the reader knows about matrix algebra in the class description and then keep brief function descriptions.</div>
</div><br clear="all">How does that sound? I am hoping to add some more inline doxygen code examples to some of the new code I have added, examples of which can already be seen (not by me) in the OpenGLExtensionManager header.<div>
<br></div><div>Marcus<br>-- <br>Marcus D. Hanwell, Ph.D.<br>R&D Engineer, Kitware Inc.<br>(518) 881-4937<br>
</div>