[Insight-developers] Run Doxygen? (itk::Math namespace)

Bradley Lowekamp blowekamp at mail.nih.gov
Tue Mar 30 11:11:35 EDT 2010


Kent,

I am still using the one from the FAQ:
http://www.itk.org/Wiki/ITK_FAQ#EMACS_configuration_file_:_ITK_coding_style

If it's not the best one, then I'd like to know, and it should be updated.

I just saw the doxymacs too. That looks a little too heavy weight. 

Something like the following is close to what I'd like:
http://www.emacswiki.org/emacs/DoxyMacs

just need to learn elisp to tweak it. 

Brad


On Mar 30, 2010, at 10:47 AM, kent williams wrote:

> I googled Doxygen Emacs and found this:
> http://doxymacs.sourceforge.net/
> 
> 
> On 3/30/10 9:27 AM, "Luis Ibanez" <luis.ibanez at kitware.com> wrote:
> 
>> Hi Brad,
>> 
>> I would be in favor of sticking to a single standard
>> notation for Doxygen comments.
>> 
>> It will be surprising if there is no automatic way
>> of dealing with Doxygen indentation in Emacs.
>> 
>>  ... there is certainly one in Vim...        :-)
>> 
>> 
>> Doxygen supports at least four different notations
>> for documentation comments.
>> 
>>   http://www.doxygen.nl/docblocks.html
>> 
>> Mixing them up in the code will simply lead to
>> confusion.
>> 
>> The files in the Review directory are in...  "review".
>> If they are not conforming yet to the ITK standards,
>> we simply have to fix them there before they can
>> be moved to their final location in a stable directory.
>> 
>> 
>> We have bigger and more real problems to deal with
>> at this point to have to spend time going back on
>> reviewing the standards of code documentation.
>> 
>> I would rather invest time on fixing our Windows 64
>> issues, or crawling out of the Copyright nightmare
>> with ACM licensed code.
>> 
>> 
>>    Luis
>> 
>> 
>> ------------------------------------------------------------
>> On Mon, Mar 29, 2010 at 8:42 PM, Bradley Lowekamp
>> <blowekamp at mail.nih.gov> wrote:
>>> Hello Luis,
>>> 
>>> I have a preference for that notation because it plays better with emacs. The
>>> auto indent, automatically prefixing on a new line etc... The multiline
>>> syntax of becomes tedious, to get things lined up correctly while editing the
>>> text. Emacs could likely be configured correctly for this style, but I don't
>>> know how to do that.
>>> 
>>> Also I am how to use /** */ with doxygen command line @{ or @cond. Is:
>>> /** @{ */
>>> correct?
>>> 
>>> Lastly, I didn't know that is was specified in the Style Guide in section
>>> 3.8:
>>> http://www.itk.org/Wiki/images/c/c6/ITKStyle.pdf
>>> 
>>> There also some other files (largely in review), which use this style as
>>> well.
>>> 
>>> Should I change it to conform?
>>> 
>>> Thanks,
>>> Brad
>>> 
>>> 
>>> 
>>> 
>>> 

========================================================
Bradley Lowekamp  
Lockheed Martin Contractor for
Office of High Performance Computing and Communications
National Library of Medicine 
blowekamp at mail.nih.gov


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://www.itk.org/mailman/private/insight-developers/attachments/20100330/f7e82db4/attachment.htm>


More information about the Insight-developers mailing list