[doc] Update doc of setCurveMode

Gepetto · Dec 7, 2017 · be5fed1 · be5fed1
1 parent a7ed7dd
commit be5fed1
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 3 deletions.
diff --git a/doc/opengl_primitives.png b/doc/opengl_primitives.png
diff --git a/idl/gepetto/viewer/graphical-interface.idl b/idl/gepetto/viewer/graphical-interface.idl
@@ -189,8 +189,10 @@ typedef sequence<Position> PositionSeq;
     /// \param input lineName : name of the line.
     /// \param input pos : waypoints of the curve.
     boolean setCurvePoints(in string curveName, in PositionSeq pos) raises (Error);
-
 
+    /// \param mode The list of possible GL modes is provided in
+    ///             WindowsManager::setCurveMode.
+    ///             From the GL modes, remove "GL_" and put it lower case.
     boolean setCurveMode (in string curveName, in string mode) raises (Error);
 
     boolean setCurvePointsSubset (in string curveName, in long first, in long count) raises (Error);

diff --git a/include/gepetto/viewer/corba/windows-manager.hh b/include/gepetto/viewer/corba/windows-manager.hh
@@ -197,8 +197,7 @@ namespace graphics {
 
             virtual bool setCurvePoints(const std::string& curveName, const Vec3ArrayPtr_t& pos);
 
-            /// See http://svn.openscenegraph.org/osg/OpenSceneGraph-Data/trunk/Images/primitives.gif for
-            /// possible values
+            /// \image html opengl_primitives.png
             virtual bool setCurveMode (const std::string& curveName, const GLenum mode);
             virtual bool setCurvePointsSubset (const std::string& curveName, const int first, const std::size_t count);
             virtual bool setCurveLineWidth (const std::string& curveName, const float& width);