Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Non-existing tags and files reported by Doxygen build #3655

Closed
jhlegarreta opened this issue Sep 25, 2022 · 3 comments
Closed

Non-existing tags and files reported by Doxygen build #3655

jhlegarreta opened this issue Sep 25, 2022 · 3 comments
Labels
type:Documentation Documentation improvement or change

Comments

@jhlegarreta
Copy link
Member

Description

The ITKDoxygen build is reporting a few non-existing warnings about some tags and files, e.g. in
https://github.com/InsightSoftwareConsortium/ITKDoxygen/actions/runs/3120254526/jobs/5060690356#step:4:1160

warning: Invalid value for 'ALIASES' tag at line 31, file /work/ITK-bld/Utilities/Doxygen/Doxyfile.Documentation: Values in list '"starteraliasnotused=@par not used" "wiki=\par Wiki Examples:<br> ^^ \li <a href="https://www.itk.org/Wiki/ITK/Examples">All Media Wiki Examples</a> ^^" "wikiexample{2}= \li <a href="[https://www.itk.org/Wiki/ITK/Examples/\1](https://www.itk.org/Wiki/ITK/Examples//1)">\2</a> ^^" "endwiki=^^ ^^ ^^" "sphinx=\par ITK Sphinx Examples:<br> ^^ \li <a href="https://itk.org/ITKExamples">All ITK Sphinx Examples</a> ^^" "sphinxexample{2}=\li <a href="[https://itk.org/ITKExamples/src/\1/Documentation.html](https://itk.org/ITKExamples/src//1/Documentation.html)">\2</a> ^^" "endsphinx=^^ ^^ ^^"' are not properly space or comma separated
error: Illegal ALIASES format 'https://www.itk.org/Wiki/ITK/Examples>All Media Wiki Examples</a> ^^'. Use "name=value" or "name{n}=value", where n is the number of arguments
error: Illegal ALIASES format '[https://www.itk.org/Wiki/ITK/Examples/\1](https://www.itk.org/Wiki/ITK/Examples//1)>\2</a> ^^'. Use "name=value" or "name{n}=value", where n is the number of arguments
error: Illegal ALIASES format 'https://itk.org/ITKExamples>All ITK Sphinx Examples</a> ^^'. Use "name=value" or "name{n}=value", where n is the number of arguments
error: Illegal ALIASES format '[https://itk.org/ITKExamples/src/\1/Documentation.html](https://itk.org/ITKExamples/src//1/Documentation.html)>\2</a> ^^'. Use "name=value" or "name{n}=value", where n is the number of arguments

and

warning: tag INPUT: input source '/work/ITK-bld/Documentation/Doxygen' does not exist
warning: tag INPUT: input source '/work/ITK-bld/Documentation/Doxygen/Examples.dox' does not exist

and

Searching for files in directory /work/ITK/Moduleswarning: source '/work/ITK-bld/Documentation/Doxygen' is not a readable file or directory... skipping.
warning: source '/work/ITK-bld/Documentation/Doxygen/Examples.dox' is not a readable file or directory... skipping.

in https://github.com/InsightSoftwareConsortium/ITKDoxygen/actions/runs/3120254526/jobs/5060690356#step:4:2787

Expected information

The Doxygen build should be clean.

Actual information

The groups seem to be present and working as expected in the impacted classes' Doxygen pages, but fixing the warnings is necessary to keep the toolkit healthy and to avoid distractions.

Versions

master

Additional Information

None.

@jhlegarreta jhlegarreta added area:Documentation Issues affecting the Documentation module type:Documentation Documentation improvement or change and removed area:Documentation Issues affecting the Documentation module labels Sep 25, 2022
@jhlegarreta
Copy link
Member Author

Still relevant as recent runs still show these warnings, e.g.
https://github.com/InsightSoftwareConsortium/ITKDoxygen/actions/runs/12919384647/job/36029790740

But unsure anybody is willing to address this.

@albert-github
Copy link
Contributor

Regarding the ALIASES this has been fixed, see #3654 (comment) and commit 9f315af

The other 2 problems I didn't see in my outputs nor in the output of the link as mentioned in #3655 (comment)

@jhlegarreta
Copy link
Member Author

The other 2 problems I didn't see in my outputs nor in the output of the link as mentioned in #3655 (comment)

To be honest, when I wrote #3655 (comment), I only had a look at the ALIASES issue. I see that the build log I pointed to does not show the

warning: tag INPUT: input source '/work/ITK-bld/Documentation/Doxygen' does not exist
warning: tag INPUT: input source '/work/ITK-bld/Documentation/Doxygen/Examples.dox' does not exist

and

Searching for files in directory /work/ITK/Moduleswarning: source '/work/ITK-bld/Documentation/Doxygen' is not a readable file or directory... skipping.
warning: source '/work/ITK-bld/Documentation/Doxygen/Examples.dox' is not a readable file or directory... skipping.

issue, so closing. Can be re-opened if we encounter them in other builds. Thanks for the heads-up and work @albert-github.

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
type:Documentation Documentation improvement or change
Projects
None yet
Development

No branches or pull requests

2 participants