Hi Dean,<div><br></div><div>There are different styles of comments currently in CTK. However they seem to be closely following the Qt documentation style. The style is very similar to the standard Doxygen style:</div><div>

<br></div><div>/*!</div><div>    \class QPushButton</div><div>    \brief The QPushButton widget provides a command button.</div><div><br></div><div>    \ingroup basicwidgets</div><div><br></div><div><br></div><div>    The push button, or command button, is perhaps the most commonly</div>

<div>    used widget in any graphical user interface. Push (click) a button</div><div>    to command the computer to perform some action, or to answer a</div><div>    question. Typical buttons are OK, Apply, Cancel, Close, Yes, No</div>

<div>    and Help.</div><div>    ...</div><div>    \sa QToolButton</div><div>*/</div><div><br></div><div>Sometimes (in Libs/Widgets), we use /// in front of each line of comment instead of wrapping all the comments with /*!  */</div>

<div>I've seen /** */ as well.</div><div><br></div><div>As you suggested, we should probably pick a style and stick with it.</div><div>I have a preference for following the Qt style (but adding the comments in the .h file and not in the .cpp). If we end up all having a very different opinion we can start a doodle poll.</div>

<div><br></div><div>Julien.</div><div><br><div class="gmail_quote">On Wed, Nov 10, 2010 at 8:39 AM, Dean Inglis <span dir="ltr"><<a href="mailto:dean.inglis@camris.ca">dean.inglis@camris.ca</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex;">

Is there a plan to add documentation about ctk classes<br>
and their methods in a manner similar to what is done<br>
with vtk or itk classes?  ie. vtk style is ...<br>
<br>
// .NAME ctkClass - brief description of what it does <br>
// .SECTION Description<br>
// The longer description of what it does etc.<br>
<br>
// .SECTION Event Bindings<br>
// something about the slots and signals?<br>
<br>
// .SECTION Caveats<br>
// useage warnings<br>
<br>
// .SECTION See Also<br>
// other classes related to or critical to this class<br>
<br>
Dean<br>
_______________________________________________<br>
Ctk-developers mailing list<br>
<a href="mailto:Ctk-developers@commontk.org" target="_blank">Ctk-developers@commontk.org</a><br>
<a href="http://public.kitware.com/cgi-bin/mailman/listinfo/ctk-developers" target="_blank">http://public.kitware.com/cgi-bin/mailman/listinfo/ctk-developers</a><br>
</blockquote></div><br></div>