Improved docblock

Signed-off-by: ahcorde <[email protected]>
gazebosim · Dec 23, 2020 · b50de42 · b50de42
1 parent 8a4493b
commit b50de42
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/ogre/include/ignition/rendering/ogre/OgreMaterial.hh b/ogre/include/ignition/rendering/ogre/OgreMaterial.hh
@@ -107,7 +107,10 @@ namespace ignition
       public: virtual float RenderOrder() const override;
 
       // Documentation inherited
-      public: virtual void SetRenderOrder(const float _enabled) override;
+      // Review the official documentation to get more details about this
+      // parameter, in particular Ogre::Pass::setDepthBias()
+      // https://www.ogre3d.org/docs/api/1.8/class_ogre_1_1_pass.html
+      public: virtual void SetRenderOrder(const float _renderOrder) override;
 
       public: virtual bool ReflectionEnabled() const override;
 

diff --git a/ogre2/include/ignition/rendering/ogre2/Ogre2Material.hh b/ogre2/include/ignition/rendering/ogre2/Ogre2Material.hh
@@ -75,7 +75,9 @@ namespace ignition
       public: virtual float RenderOrder() const override;
 
       // Documentation inherited
-      public: virtual void SetRenderOrder(const float _enabled) override;
+      // Review the official documentation to get more details about this
+      // parameter, in particular mDepthBiasConstant
+      public: virtual void SetRenderOrder(const float _renderOrder) override;
 
       // Documentation inherited
       public: virtual bool ReceiveShadows() const override;