Documentation

Signed-off-by: Nate Koenig <nate@openrobotics.org>
gazebosim · Feb 16, 2022 · af17afe · af17afe
1 parent 53063fb
commit af17afe
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 8 deletions.
diff --git a/src/SimulationRunner.cc b/src/SimulationRunner.cc
@@ -128,7 +128,6 @@ SimulationRunner::SimulationRunner(const sdf::World *_world,
   // Create the level manager
   this->levelMgr = std::make_unique<LevelManager>(this, _config.UseLevels());
 
-
   // Check if this is going to be a distributed runner
   // Attempt to create the manager based on environment variables.
   // If the configuration is invalid, then networkMgr will be `nullptr`.

diff --git a/src/SystemManager.hh b/src/SystemManager.hh
@@ -54,31 +54,31 @@ namespace ignition
                               const std::string &_name,
                               const sdf::ElementPtr &_sdf);
 
-      /// \brief Add system to the manager
+      /// \brief Add a system to the manager
       /// \param[in] _system SystemPluginPtr to be added
       /// \param[in] _entity Entity that system is attached to.
       /// \param[in] _sdf Pointer to the SDF of the entity.
       public: void AddSystem(const SystemPluginPtr &_system,
                              Entity _entity,
                              std::shared_ptr<const sdf::Element> _sdf);
 
-      /// \brief Add system to the manager
+      /// \brief Add a system to the manager
       /// \param[in] _system SystemPluginPtr to be added
       /// \param[in] _entity Entity that system is attached to.
       /// \param[in] _sdf Pointer to the SDF of the entity.
       public: void AddSystem(const std::shared_ptr<System> &_system,
                              Entity _entity,
                              std::shared_ptr<const sdf::Element> _sdf);
 
-      /// \brief Get count of currently active systems
-      /// \return The count.
+      /// \brief Get the count of currently active systems.
+      /// \return The active systems count.
       public: size_t ActiveCount() const;
 
-      /// \brief Get count of currently pending systems
-      /// \return The count.
+      /// \brief Get the count of currently pending systems.
+      /// \return The pending systems count.
       public: size_t PendingCount() const;
 
-      /// \brief Get count of all (pending + active) managed systems
+      /// \brief Get the count of all (pending + active) managed systems
       /// \return The count.
       public: size_t TotalCount() const;