Skip to content

DOC: inconsistent dependensies for documentation build #6545

Description

@albert-github

When generating the ITK documentation on an existing directory (updated to the current main version: 65e69c8) I got the warnings:

<Examples/RegistrationITKv4/DeformableRegistration1.cxx>:3: warning: included file 'Examples/RegistrationITKv4/DeformableRegistration1.cxx' is not found. Check your EXAMPLE_PATH
<Examples/RegistrationITKv4/DeformableRegistration11.cxx>:3: warning: included file 'Examples/RegistrationITKv4/DeformableRegistration11.cxx' is not found. Check your EXAMPLE_PATH

I was able to solve the problem by removing the file: build/Documentation/Doxygen/Examples.dox and regenerating the documentation, but this is of course not the best way to do it.
(unfortunately the doxygen warning is not the best either, so this is where the doxygen team has to have a look at).

Wouldn't it be possible to add some dependencies to the build system that address this issue and automatically regenerate the build/Documentation/Doxygen/Examples.dox when the respective files change (the number and, unfortunately, possibly also the content).
e.g in

  • Utilities/Doxygen/CMakeLists.txt adding "recursive" dependency to the add_custom_command for "# Custom command to generate a examples page which include all ITK examples" i.e. adjust the dependency line ${ITK_SOURCE_DIR}/Examples like the GLOB_RECURSE in `Utilities/Doxygen/GenerateExamplesDox.cmake

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions