<html><head><meta http-equiv="content-type" content="text/html; charset=utf-8"></head><body dir="auto"><div></div><div style="direction: inherit;">I like the /** ... */ style comments with an explicit \brief keyword where warranted.</div><div style="direction: inherit;"><br></div><div style="direction: inherit;">I also strongly advocate putting documentation wherever the implementation is, rather than the declaration, on the principal that people who change the implementation will be more likely to update the docs that way.</div><div style="direction: inherit;"><br></div><div style="direction: inherit;"> David</div><div><br>On Sep 17, 2016, at 10:24, David Cole via vtk-developers <<a href="mailto:vtk-developers@vtk.org">vtk-developers@vtk.org</a>> wrote:<br><br></div><blockquote type="cite"><div><meta http-equiv="content-type" content="text/html; charset=utf-8"><div>For what it's worth, I've always found reading the /// style throughout to be the easiest on my brain and eyes when reading in a text editor. For some reason, it seems to be easiest to filter out a constant column of /// repeated on every line than the sprinkled start/stop signals of the other styles.</div><div><br>Just my 2 cents,<br><div>David C.</div></div><div id="AppleMailSignature"><br></div><div><br>On Sep 17, 2016, at 9:24 AM, Will Schroeder <<a href="mailto:will.schroeder@kitware.com">will.schroeder@kitware.com</a>> wrote:<br><br></div><blockquote type="cite"><div><div dir="ltr">For reference, I believe ITK uses /** text */<div><br></div><div><div> /** Method for creation through the object factory. */</div></div><div><br></div><div>and</div><div><br></div><div><div> /** A global data type for this class of equations. Used to store</div><div> * values that are needed in calculating the time step and other intermediate</div><div> * products such as derivatives that may be used by virtual functions called</div><div> * from ComputeUpdate. Caching these values here allows the ComputeUpdate</div><div> * function to be const and thread safe. */</div></div><div><br></div><div><br></div></div><div class="gmail_extra"><br><div class="gmail_quote">On Fri, Sep 16, 2016 at 2:41 PM, David E DeMarle <span dir="ltr"><<a href="mailto:dave.demarle@kitware.com" target="_blank">dave.demarle@kitware.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div dir="ltr"><div><div><div><div>Hey Folks,<br><br></div>I'm getting ready to replace VTK's non-standard documentation comment style with normal doxygen markup. Once we do that IDEs will generally do the right thing and we can all more easily edit the headers and get exactly what we expect.<br><br></div><div>Before I make the big initial conversion commit, what specific doxygen flavor do people prefer?<br><br></div>/*! and //! vs /** and /// <br></div>all c-style (/*) or all c++ style (//) or mixed OK?<br></div><div><div></div>for c-style, leading *'s or not in continuation lines<br></div><div><br></div><div><div><div><div><div>thanks<span class="HOEnZb"><font color="#888888"><br><br></font></span></div><span class="HOEnZb"><font color="#888888"><div><div><div><div><div data-smartmail="gmail_signature">David E DeMarle<br>Kitware, Inc.<br>R&D Engineer<br>21 Corporate Drive<br>Clifton Park, NY 12065-8662<br>Phone: <a href="tel:518-881-4909" value="+15188814909" target="_blank">518-881-4909</a></div></div>
</div></div></div></font></span></div></div></div></div></div>
<br>______________________________<wbr>_________________<br>
Powered by <a href="http://www.kitware.com" rel="noreferrer" target="_blank">www.kitware.com</a><br>
<br>
Visit other Kitware open-source projects at <a href="http://www.kitware.com/opensource/opensource.html" rel="noreferrer" target="_blank">http://www.kitware.com/<wbr>opensource/opensource.html</a><br>
<br>
Search the list archives at: <a href="http://markmail.org/search/?q=vtk-developers" rel="noreferrer" target="_blank">http://markmail.org/search/?q=<wbr>vtk-developers</a><br>
<br>
Follow this link to subscribe/unsubscribe:<br>
<a href="http://public.kitware.com/mailman/listinfo/vtk-developers" rel="noreferrer" target="_blank">http://public.kitware.com/<wbr>mailman/listinfo/vtk-<wbr>developers</a><br>
<br>
<br></blockquote></div><br><br clear="all"><div><br></div>-- <br><div class="gmail_signature" data-smartmail="gmail_signature"><div dir="ltr"><div>William J. Schroeder, PhD<br>Kitware, Inc. - Building the World's Technical Computing Software<br>28 Corporate Drive<br>Clifton Park, NY 12065<br><a href="mailto:will.schroeder@kitware.com" target="_blank">will.schroeder@kitware.com</a><br><a href="http://www.kitware.com" target="_blank">http://www.kitware.com</a><br>(518) 881-4902</div></div></div>
</div>
</div></blockquote><blockquote type="cite"><div><span>_______________________________________________</span><br><span>Powered by <a href="http://www.kitware.com">www.kitware.com</a></span><br><span></span><br><span>Visit other Kitware open-source projects at <a href="http://www.kitware.com/opensource/opensource.html">http://www.kitware.com/opensource/opensource.html</a></span><br><span></span><br><span>Please keep messages on-topic and check the VTK FAQ at: <a href="http://www.vtk.org/Wiki/VTK_FAQ">http://www.vtk.org/Wiki/VTK_FAQ</a></span><br><span></span><br><span>Search the list archives at: <a href="http://markmail.org/search/?q=vtkusers">http://markmail.org/search/?q=vtkusers</a></span><br><span></span><br><span>Follow this link to subscribe/unsubscribe:</span><br><span><a href="http://public.kitware.com/mailman/listinfo/vtkusers">http://public.kitware.com/mailman/listinfo/vtkusers</a></span><br></div></blockquote></div></blockquote><blockquote type="cite"><div><span>_______________________________________________</span><br><span>Powered by <a href="http://www.kitware.com">www.kitware.com</a></span><br><span></span><br><span>Visit other Kitware open-source projects at <a href="http://www.kitware.com/opensource/opensource.html">http://www.kitware.com/opensource/opensource.html</a></span><br><span></span><br><span>Search the list archives at: <a href="http://markmail.org/search/?q=vtk-developers">http://markmail.org/search/?q=vtk-developers</a></span><br><span></span><br><span>Follow this link to subscribe/unsubscribe:</span><br><span><a href="http://public.kitware.com/mailman/listinfo/vtk-developers">http://public.kitware.com/mailman/listinfo/vtk-developers</a></span><br><span></span><br></div></blockquote></body></html>