[Insight-developers] Doxygen EXAMPLE_PATH and modularization ?

[Arnaud GELAS]

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

[Brad King]

Post by Arnaud GELAS
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?

In the top-level CMakeLists.txt file move this block:

#----------------------------------------------------------------------
# Provide an option for generating documentation.
add_subdirectory(Utilities/Doxygen)

to the bottom of the file. Then add this in Utilities/Doxygen/CMakeLists.txt:

foreach(itk-module ${ITK_MODULES_ALL})
if(${itk-module}_IS_TEST)
list(APPEND DOXYGEN_TEST_DIRS "${${itk-module}_SOURCE_DIR}")
endif()
endforeach()

-Brad

[Arnaud GELAS]

Post by Brad King

Post by Arnaud GELAS
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?

#----------------------------------------------------------------------
# Provide an option for generating documentation.
add_subdirectory(Utilities/Doxygen)
foreach(itk-module ${ITK_MODULES_ALL})
if(${itk-module}_IS_TEST)
list(APPEND DOXYGEN_TEST_DIRS "${${itk-module}_SOURCE_DIR}")
endif()
endforeach()
-Brad

Exactly what I was looking for :)

Thanks,
Arnaud

[Bradley Lowekamp]

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

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

Post by Arnaud GELAS
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
Visit other Kitware open-source projects at
http://www.kitware.com/opensource/opensource.html
http://kitware.com/products/protraining.html
http://www.itk.org/Wiki/ITK_FAQ
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
***@mail.nih.gov

[Arnaud GELAS]

Excellent!!!

I'll use this one as a basis for ITK

Thanks,
Arnaud

Post by Bradley Lowekamp
Arnaud,
I just worked on automatically including the examples in the
https://github.com/blowekamp/SimpleITK/compare/master...43-AutomaticExamplesDox
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

Post by Arnaud GELAS
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
http://kitware.com/products/protraining.html
http://www.itk.org/Wiki/ITK_FAQ
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