Skip to content

ci: enable doxygen checks #2943

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.

Sign up for GitHub

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

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

ci: enable doxygen checks #2943

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e9714a0
ci: enable doxygen checks
scpeters Jun 9, 2025
61d1733
System.hh: fix doxygen
scpeters Jun 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ jobs:
id: ci
uses: gazebo-tooling/action-gz-ci@noble
with:
# per bug https://github.com/gazebosim/gz-sim/issues/1409
cmake-args: '-DCMAKE_INSTALL_PREFIX=/usr -DBUILD_DOCS=OFF -DCMAKE_BUILD_TYPE=RelWithDebInfo -DENABLE_GUI=OFF'
cmake-args: '-DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=RelWithDebInfo -DENABLE_GUI=OFF'
cppcheck-enabled: true
cpplint-enabled: true
doxygen-enabled: true
12 changes: 6 additions & 6 deletions include/gz/sim/System.hh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ namespace gz
constexpr System::PriorityType kPostPhysicsSensorPriority = -32;
}

/// \class ISystemConfigure ISystem.hh gz/sim/System.hh
/// \class ISystemConfigure System.hh gz/sim/System.hh
/// \brief Interface for a system that implements optional configuration
///
/// Configure is called after the system is instantiated and all entities
Expand All @@ -149,7 +149,7 @@ namespace gz
EventManager &_eventMgr) = 0;
};

/// \class ISystemConfigure ISystem.hh gz/sim/System.hh
/// \class ISystemConfigure System.hh gz/sim/System.hh
/// \brief Interface for a system that implements optional configuration
/// of the default priority value.
///
Expand All @@ -163,7 +163,7 @@ namespace gz
public: virtual System::PriorityType ConfigurePriority() = 0;
};

/// \class ISystemConfigureParameters ISystem.hh gz/sim/System.hh
/// \class ISystemConfigureParameters System.hh gz/sim/System.hh
/// \brief Interface for a system that declares parameters.
///
/// ISystemConfigureParameters::ConfigureParameters is called after
Expand All @@ -182,21 +182,21 @@ namespace gz
EntityComponentManager &_ecm) = 0;
};

/// \class ISystemPreUpdate ISystem.hh gz/sim/System.hh
/// \class ISystemPreUpdate System.hh gz/sim/System.hh
/// \brief Interface for a system that uses the PreUpdate phase
class ISystemPreUpdate {
public: virtual void PreUpdate(const UpdateInfo &_info,
EntityComponentManager &_ecm) = 0;
};

/// \class ISystemUpdate ISystem.hh gz/sim/System.hh
/// \class ISystemUpdate System.hh gz/sim/System.hh
/// \brief Interface for a system that uses the Update phase
class ISystemUpdate {
public: virtual void Update(const UpdateInfo &_info,
EntityComponentManager &_ecm) = 0;
};

/// \class ISystemPostUpdate ISystem.hh gz/sim/System.hh
/// \class ISystemPostUpdate System.hh gz/sim/System.hh
/// \brief Interface for a system that uses the PostUpdate phase
class ISystemPostUpdate{
public: virtual void PostUpdate(const UpdateInfo &_info,
Expand Down