Docs fixes

Signed-off-by: Matias N. Goldberg <dark_sylinc@yahoo.com.ar>
gazebosim · Jul 31, 2022 · b387b8b · b387b8b
1 parent 2250401
commit b387b8b
Show file tree

Hide file tree

Showing 3 changed files with 2 additions and 3 deletions.
diff --git a/examples/global_illumination/Main.cc b/examples/global_illumination/Main.cc
@@ -381,7 +381,6 @@ int main(int _argc, char **_argv)
     }
     catch (...)
     {
-      // std::cout << ex.what() << std::endl;
       std::cerr << "Error starting up: " << engineName << std::endl;
     }
   }

diff --git a/include/gz/rendering/GlobalIlluminationCiVct.hh b/include/gz/rendering/GlobalIlluminationCiVct.hh
@@ -117,7 +117,7 @@ namespace gz
     /// be stable.
     /// Very big step sizes may cause periodic performance spikes or sudden
     /// changes in brightness.
-    /// \param[in] _stepSize
+    /// \param[in] _stepSize Step size in units
     public: virtual void SetCameraStepSize(
           const gz::math::Vector3d &_stepSize) = 0;
 
@@ -165,6 +165,7 @@ namespace gz
     /// \remark Cannot be called anymore after Start() has been called
     /// \param[in] _ref Can be nullptr. If you already have a cascade,
     /// we will clone its settings.
+    /// \return New Cascade to control its settings.
     public: virtual CiVctCascadePtr AddCascade(const CiVctCascade *_ref) = 0;
 
     /// \brief Removes the last added cascade.

diff --git a/include/gz/rendering/Scene.hh b/include/gz/rendering/Scene.hh
@@ -1181,7 +1181,6 @@ namespace gz
       /// will automatically be assigned to the GI. If the given ID is
       /// already in use, NULL will be returned.
       /// \param[in] _id ID of the new particle emitter
-      /// \param[in] _name Name of the new GI VCT solution
       /// \return The created GI VCT
       public: virtual GlobalIlluminationVctPtr CreateGlobalIlluminationVct(
                   unsigned int _id) = 0;