Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

API doc generation fails with doxygen >= 1.10.0 #4370

Closed
1 task done
panicgh opened this issue Feb 9, 2024 · 0 comments · Fixed by #4376
Closed
1 task done

API doc generation fails with doxygen >= 1.10.0 #4370

panicgh opened this issue Feb 9, 2024 · 0 comments · Fixed by #4376
Labels
triage Issue pending classification

Comments

@panicgh
Copy link

panicgh commented Feb 9, 2024

Is there an already existing issue for this?

  • I have searched the existing issues

Expected behavior

Build passes, doxygen generates API doc without error.

Current behavior

Build fails with doxygen >= 1.10.0.

The doxygen 1.10.0 changelog mentions:

Submit warning when the ingroup command is used with an non-existing group name [view] and [view]

and Fast-DDS's doxygen config contains:

WARN_AS_ERROR = YES

An inconsistency in the documentation triggers the new doxygen warning, which is being treated as error:

/build/source/include/fastrtps/types/AnnotationParameterValue.h:64: error: Found non-existing group 'ANNOTATIONPARAMETERVALUE' for the command '@ingroup', ignoring command (warning treated as error, aborting now)

Steps to reproduce

  • Get doxygen >= 1.10.0
  • Get Fast-DDS v2.13.1
  • Run cmake with -DBUILD_DOCUMENTATION=ON
  • Try to build FastDDS

Fast DDS version/commit

v2.13.1

https://github.com/eProsima/Fast-DDS/blob/v2.13.1/doxyfile.in#L839

Platform/Architecture

Other. Please specify in Additional context section.

Transport layer

Default configuration, UDPv4 & SHM

Additional context

Happens on any platform that uses doxygen >= 1.10.0.

See also eProsima/Fast-CDR#193.

XML configuration file

No response

Relevant log output

No response

Network traffic capture

No response

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
triage Issue pending classification
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant