ci: enable doxygen checking

[scpeters]

🦟 Bug fix

Part of gazebo-tooling/release-tools#1222

Summary

Enables checking doxygen in CI. Currently has errors.

Checklist

• Signed all commits for DCO
• Added tests
• Updated documentation (as needed)
• Updated migration guide (as needed)
• Consider updating Python bindings (if the library has them)
• codecheck passed (See contributing)
• All tests passed (See test coverage)
• While waiting for a review on your PR, please help review another open pull request to support the maintainers

Note to maintainers: Remember to use Squash-Merge and edit the commit message to match the pull request summary while retaining Signed-off-by messages.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.87%. Comparing base (25fe977) to head (8bd5272).
Report is 4 commits behind head on gz-common6.

Additional details and impacted files

@@              Coverage Diff               @@
##           gz-common6     #674      +/-   ##
==============================================
+ Coverage       84.86%   84.87%   +0.01%     
==============================================
  Files              78       78              
  Lines           10141    10151      +10     
==============================================
+ Hits             8606     8616      +10     
  Misses           1535     1535              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[scpeters]

this currently has the following doxygen complaints to be fixed:

 /github/workspace/include/gz/common/EnumIface.hh:261: warning: File ended in the middle of a comment block! Perhaps a missing \endcode?
  /github/workspace/graphics/include/gz/common/MeshManager.hh:324: warning: Found ';' while parsing initializer list! (doxygen could be confused by a macro call without semicolon)
  /github/workspace/geospatial/include/gz/common/geospatial/Dem.hh:38: warning: the name 'DEM.hh' supplied as the argument of the \class, \struct, \union, or \include command is not an input file
  /github/workspace/events/include/gz/common/Event.hh:181: warning: documentation for unknown define EvtConnectionMap found.
  /github/workspace/graphics/include/gz/common/Material.hh:40: warning: documentation for unknown define Shade modes found.
  /github/workspace/graphics/include/gz/common/Material.hh:67: warning: documentation for unknown define Blend modes found.
  /github/workspace/include/gz/common/MovingWindowFilter.hh:55: warning: documented symbol 'MovingWindowFilterPrivate' was not declared or defined.
  /github/workspace/av/include/gz/common/HWVideo.hh:23: warning: documented symbol 'enum GZ_COMMON_AV_VISIBLE HWEncoderType' was not declared or defined.
  /github/workspace/testing/include/gz/common/testing/TestPaths.hh:51: warning: documented symbol 'enum GZ_COMMON_TESTING_VISIBLE BuildType' was not declared or defined.
  /github/workspace/graphics/include/gz/common/SkeletonNode.hh:162: warning: Found unknown command '\detail'
  /github/workspace/include/gz/common/SystemPaths.hh:162: warning: Found unknown command '\description'
  /github/workspace/tutorials/install.md:228: warning: unable to resolve reference to 'source-install' for \ref command
  /github/workspace/tutorials/profiler.md:25: warning: explicit link request to 'profiler' could not be resolved
  /github/workspace/include/gz/common/Filesystem.hh:194: warning: argument '_source' of command @param is not found in the argument list of gz::common::copyDirectory(const std::string &_existingDirname, const std::string &_newDirname, const FilesystemWarningOp _warningOp=FSWO_LOG_WARNINGS)
  /github/workspace/include/gz/common/Filesystem.hh:194: warning: argument '_destination' of command @param is not found in the argument list of gz::common::copyDirectory(const std::string &_existingDirname, const std::string &_newDirname, const FilesystemWarningOp _warningOp=FSWO_LOG_WARNINGS)
  /github/workspace/include/gz/common/Filesystem.hh:194: warning: The following parameters of gz::common::copyDirectory(const std::string &_existingDirname, const std::string &_newDirname, const FilesystemWarningOp _warningOp=FSWO_LOG_WARNINGS) are not documented:
  /github/workspace/graphics/include/gz/common/NodeAnimation.hh:46: warning: argument 'the' of command @param is not found in the argument list of NodeAnimation::SetName(const std::string &_name)
  /github/workspace/graphics/include/gz/common/NodeAnimation.hh:46: warning: The following parameter of gz::common::NodeAnimation::SetName(const std::string &_name) is not documented:
    parameter '_name'
  /github/workspace/graphics/include/gz/common/Pbr.hh:69: warning: argument '_in' of command @param is not found in the argument list of Pbr::operator!=(const Pbr &_pbr) const
  /github/workspace/graphics/include/gz/common/Pbr.hh:70: warning: Found unknown command '\returen'
  /github/workspace/graphics/include/gz/common/Pbr.hh:69: warning: The following parameter of gz::common::Pbr::operator!=(const Pbr &_pbr) const is not documented:
    parameter '_pbr'
  /github/workspace/graphics/include/gz/common/Pbr.hh:63: warning: argument '_in' of command @param is not found in the argument list of Pbr::operator==(const Pbr &_pbr) const
  /github/workspace/graphics/include/gz/common/Pbr.hh:64: warning: Found unknown command '\returen'
  /github/workspace/graphics/include/gz/common/Pbr.hh:63: warning: The following parameter of gz::common::Pbr::operator==(const Pbr &_pbr) const is not documented:
    parameter '_pbr'
  /github/workspace/graphics/include/gz/common/Skeleton.hh:84: warning: argument 'the' of command @param is not found in the argument list of Skeleton::Scale(const double _scale)
  /github/workspace/graphics/include/gz/common/Skeleton.hh:84: warning: The following parameter of gz::common::Skeleton::Scale(const double _scale) is not documented:
    parameter '_scale'
  /github/workspace/graphics/include/gz/common/SkeletonNode.hh:162: warning: Found unknown command '\detail'
  /github/workspace/graphics/include/gz/common/SkeletonNode.hh:162: warning: Found unknown command '\detail'
  /github/workspace/graphics/include/gz/common/SubMesh.hh:139: warning: argument '_u' of command @param is not found in the argument list of SubMesh::AddTexCoordBySet(const gz::math::Vector2d &_uv, unsigned int _setIndex)
  /github/workspace/graphics/include/gz/common/SubMesh.hh:139: warning: argument '_v' of command @param is not found in the argument list of SubMesh::AddTexCoordBySet(const gz::math::Vector2d &_uv, unsigned int _setIndex)
  /github/workspace/graphics/include/gz/common/SubMesh.hh:139: warning: The following parameter of gz::common::SubMesh::AddTexCoordBySet(const gz::math::Vector2d &_uv, unsigned int _setIndex) is not documented:
    parameter '_uv'
  /github/workspace/graphics/include/gz/common/SubMesh.hh:356: warning: argument '_verArr' of command @param is not found in the argument list of SubMesh::FillArrays(double **_vertArr, int **_indexndArr) const
  /github/workspace/graphics/include/gz/common/SubMesh.hh:356: warning: The following parameter of gz::common::SubMesh::FillArrays(double **_vertArr, int **_indexndArr) const is not documented:
    parameter '_vertArr'
  /github/workspace/graphics/include/gz/common/SubMesh.hh:75: warning: argument '_n' of command @param is not found in the argument list of SubMesh::SetName(const std::string &_name)
  /github/workspace/graphics/include/gz/common/SubMesh.hh:75: warning: The following parameter of gz::common::SubMesh::SetName(const std::string &_name) is not documented:
    parameter '_name'
  /github/workspace/graphics/include/gz/common/SubMesh.hh:213: warning: argument '_setIndex' of command @param is not found in the argument list of SubMesh::SetTexCoordBySet(unsigned int _index, const gz::math::Vector2d &_uv, unsigned int _setIdex)
  /github/workspace/graphics/include/gz/common/SubMesh.hh:213: warning: The following parameter of gz::common::SubMesh::SetTexCoordBySet(unsigned int _index, const gz::math::Vector2d &_uv, unsigned int _setIdex) is not documented:
    parameter '_setIdex'
  /github/workspace/include/gz/common/SystemPaths.hh:162: warning: Found unknown command '\description'
  /github/workspace/include/gz/common/SystemPaths.hh:162: warning: Found unknown command '\description'
  /github/workspace/include/gz/common/TempDirectory.hh:81: warning: argument 'in' of command @param is not found in the argument list of TempDirectory::TempDirectory(const std::string &_root, const std::string &_prefix="temp_dir", const std::string &_subDir="gz", bool _cleanup=true)
  /github/workspace/include/gz/common/TempDirectory.hh:81: warning: The following parameter of gz::common::TempDirectory::TempDirectory(const std::string &_root, const std::string &_prefix="temp_dir", const std::string &_subDir="gz", bool _cleanup=true) is not documented:
    parameter '_root'
  /github/workspace/include/gz/common/URI.hh:336: warning: explicit link request to 'fragment' could not be resolved
  /github/workspace/include/gz/common/URI.hh:345: warning: The following parameter of gz::common::URI::URI(const std::string &_str, bool _hasAuthority=false) is not documented:
    parameter '_str'
  /github/workspace/include/gz/common/URI.hh:370: warning: found documented return type for gz::common::URI::SetAuthority that does not return anything
  /github/workspace/include/gz/common/URI.hh:353: warning: explicit link request to 'fragment' could not be resolved
  /github/workspace/include/gz/common/URI.hh:326: warning: argument '_str' of command @param is not found in the argument list of URIFragment::Parse(const std::string &_string)
  /github/workspace/include/gz/common/URI.hh:326: warning: The following parameter of gz::common::URIFragment::Parse(const std::string &_string) is not documented:
    parameter '_string'
  /github/workspace/include/gz/common/URI.hh:214: warning: argument '_part' of command @param is not found in the argument list of URIPath::operator==(const URIPath &_path) const
  /github/workspace/include/gz/common/URI.hh:214: warning: The following parameter of gz::common::URIPath::operator==(const URIPath &_path) const is not documented:
    parameter '_path'
  /github/workspace/include/gz/common/URI.hh:281: warning: argument '_str' of command @param is not found in the argument list of URIQuery::Parse(const std::string &_string)
  /github/workspace/include/gz/common/URI.hh:281: warning: The following parameter of gz::common::URIQuery::Parse(const std::string &_string) is not documented:
    parameter '_string'
  /github/workspace/av/include/gz/common/VideoEncoder.hh:103: warning: The following parameters of gz::common::VideoEncoder::Start(const std::string &_format, const std::string &_filename, const unsigned int _width, const unsigned int _height, const unsigned int _fps, const unsigned int _bitRate, const bool _allowHwAccel) are not documented:
    parameter '_filename'
    parameter '_fps'
    parameter '_bitRate'
  /github/workspace/av/include/gz/common/VideoEncoder.hh:138: warning: The following parameters of gz::common::VideoEncoder::Start(const std::string &_format, const std::string &_filename, unsigned int _width, unsigned int _height, unsigned int _fps, unsigned int _bitRate, const FlagSet< HWEncoderType > &_allowedHwAccel, const std::string &_hwAccelDevice="", std::optional< bool > _useHwSurface={}) are not documented:
    parameter '_filename'
    parameter '_fps'
    parameter '_bitRate'
    parameter '_useHwSurface'
  /github/workspace/av/include/gz/common/VideoEncoder.hh:54: warning: The following parameters of gz::common::VideoEncoder::Start(const std::string &_format="mp4", const std::string &_filename="", const unsigned int _width=1280, const unsigned int _height=720, const unsigned int _fps=25, const unsigned int _bitRate=0) are not documented:
    parameter '_filename'
    parameter '_fps'
    parameter '_bitRate'

[scpeters]

If someone is willing to fix these doxygen complaints, please fork from this branch and open a new pull request with the fixes. Thanks!