Doxygen

Code/include/Skeleton/Skeleton.hpp

@@ -45,6 +45,7 @@ class Skeleton
         ///        and edges
         ///
         /// \param path String containing the path to the file at format skl
+        /// \return true if the skeleton was correclty loaded
         ////////////////////////////////////////////////////////////////////////
         bool loadFromFile(std::string const& path);
 
@@ -68,6 +69,8 @@ class Skeleton
         /// \brief count the number of neighbors of each
         ///        vertex
         ///
+        /// \return a vector with the number of neighbors
+        ///
         /// Compute a vector of counters which has the same size as the number
         /// of vertices. The k-th element of the vector is the number of
         /// neighbors of the k-th vertex.
@@ -91,6 +94,11 @@ class Skeleton
         /// \brief Draw the skeleton
         ///////////////////////////////////////////////////////////////////////
         void draw() const;
+
+        ///////////////////////////////////////////////////////////////////////
+        /// \brief Draw the i-th branch of the skeleton
+        /// \param i number of the branch to draw
+        ///////////////////////////////////////////////////////////////////////
         void draw(unsigned int i) const;