[Insight-developers] Doxygen EXAMPLE_PATH and modularization ?

Arnaud GELAS arnaud_gelas at hms.harvard.edu
Wed Mar 30 18:53:10 EDT 2011


Excellent!!!

I'll use this one as a basis for ITK

Thanks,
Arnaud

On 03/30/2011 06:01 PM, Bradley Lowekamp wrote:
> Arnaud,
>
> I just worked on automatically including the examples in the 
> documentation for SimpleITK:
> https://github.com/blowekamp/SimpleITK/compare/master...43-AutomaticExamplesDox
>
> SimpleITKs doxygen include the examples tab at the top:
> http://erie.nlm.nih.gov/~blowek1/SimpleITK/examples.html 
> <http://erie.nlm.nih.gov/%7Eblowek1/SimpleITK/examples.html>
>
> It appears that doxygen does not automatically include all files in 
> the example directories into the doxygen. The cmake script 
> automatically generate a documentation file with a "\example 
> example_filename" for each example.
>
> I thought you may find this useful for ITK.
>
> Brad
>
> On Mar 30, 2011, at 5:08 PM, Arnaud GELAS wrote:
>
>> Hi all,
>>
>> In the doxygen documentation, there are references to tests.
>>
>> And we need to edit the doxygen variable EXAMPLE_PATH in consequence
>> (Examples directory as well as test directory from each module, apart
>> from 3rd part libraries). Note that doxygen expects to find tests and
>> examples in the EXAMPLE_PATH (or subdirs).
>>
>> Is there any cmake variable that could help, or that could be used to
>> fill the EXAMPLE_PATH doxygen variable?
>>
>> Thanks,
>> Arnaud
>> _______________________________________________
>> Powered by www.kitware.com <http://www.kitware.com>
>>
>> Visit other Kitware open-source projects at
>> http://www.kitware.com/opensource/opensource.html
>>
>> Kitware offers ITK Training Courses, for more information visit:
>> http://kitware.com/products/protraining.html
>>
>> Please keep messages on-topic and check the ITK FAQ at:
>> http://www.itk.org/Wiki/ITK_FAQ
>>
>> Follow this link to subscribe/unsubscribe:
>> http://www.itk.org/mailman/listinfo/insight-developers
>
> ========================================================
>
> Bradley Lowekamp
>
> Lockheed Martin Contractor for
>
> Office of High Performance Computing and Communications
>
> National Library of Medicine
>
> blowekamp at mail.nih.gov <mailto:blowekamp at mail.nih.gov>
>
>
>

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


More information about the Insight-developers mailing list