[doxy] fixing doxygen errors

Author: cvvergara

doxygen/Doxyfile.in

@@ -2249,7 +2249,7 @@ DIAFILE_DIRS           =
 # Minimum value: 0, maximum value: 10000, default value: 50.
 # This tag requires that the tag HAVE_DOT is set to YES.
 
-DOT_GRAPH_MAX_NODES    = 60
+DOT_GRAPH_MAX_NODES    = 100
 
 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
 # generated by dot. A depth value of 3 means that only nodes reachable from the

doxygen/contraction.dox

@@ -81,13 +81,13 @@ output: G'(V',E'), removed_vertices
 The contracted graph will be represented with two parameters, the modified Graph, and the removed_vertices set.
 
 ~~~~{.c}
-removed_vertices = {(v,1):{2}, (e,-1):{3}}.
+removed = {E{1},  V{2, 3}}.
 ~~~~
 
 
 The above notation indicates:
-  - Vertex 2 is removed, and belongs to vertex 1 subgraph
-  - Vertex 3 is removed, and belongs to edge -1 subgraph
+  - Edge 2 is removed
+  - Vertex 2, and 3 are removed
 
 
 
@@ -153,15 +153,9 @@ G = {E:{1(1, 2)}, V:{1, 2} }
 
 Visually the graph is
 
-
-@todo (Rohith) practice a little graphviz  :)
-
-@image html  twoNodesoneEdge_a.png
-
 @dot
 digraph G {
     1 -> 2 [label="id = 1"];
-    2 [color = lightblue,style=filled];
 }
 
 @enddot
@@ -171,7 +165,7 @@ Initial set up:
 ----------------
 
 ~~~~{.c}
-removed_vertices={}
+removed={}
 V1 = {2}
 V2 = {}
 ~~~~
@@ -199,12 +193,16 @@ Results:
 ~~~~{.c}
 
     G = {V:{1}, E:{}}
-    removed_vertices = {(v, 1):{2}}
-~~~~{.c}
+    removed = {E{1}, V{2}}
+~~~~
 
 Visually the graph is
 
-@image html  ../doc/images/twoNodesoneEdge_b.png
+@dot
+digraph G {
+    1 -> 2 [label="id = 1, has={2}"];
+}
+@enddot
 
 
 @subsection contraction_examples_linear Linear Contraction
@@ -220,12 +218,17 @@ Visually the graph is
 1. Input: G = {V:{1, 2, 3}, E:{(1, 2), (2, 3)}}
 
 Visually the graph is
-@image html  ../doc/images/threeNodestwoEdges_a.png
+@dot
+digraph G {
+    1 -> 2 [label="id = 1"];
+    2 -> 3 [label="id = 2"];
+}
+@enddot
 
 
 2. initial set up
 ~~~~{.c}
-removed_vertices={}
+removed={}
 V1 = {3}
 V2 = {2}
 ~~~~
@@ -234,24 +237,28 @@ V2 = {2}
 ~~~~{.c}
 V2 = {2} is not empty
 
-    V1 = {3}
-    removed_vertices = {(e, -1):{2}}
+    removed = {E{1}, V{2}}
+    add = {E{-1(1,3)}, V{}}
     V2 = {}
-    G = {V:{1, 3}, E:{-1(1,3,c=2)}}
+    G = {E:{-1(1,3,c=2)}, V{1,3}}
 
 V2 is empty
 ~~~~
 
 Visually the graph is
-@image html  threeNodestwoEdges_b.png
+@dot
+digraph G {
+    1 -> 3 [label="id = -1, cost = 2, has={2}"];
+}
+@enddot
 
 4. Since V2 is empty we go on to the next contraction operation
 ~~~~{.c}
 V1 = {3} is not empty
 
     V1 = {}
     V2 = {}
-    removed_vertices = {(v, 1):{3, 2}}.
+    removed = {E{-1}, V{3}}.
     G = {V:{1}, E:{}}
 
 V1 is empty
@@ -260,12 +267,15 @@ V1 is empty
 
 5. Results
 ~~~~{.c}
-removed_vertices = {(v, 1):{3, 2}}.
 G = {V:{1}, E:{}}
 ~~~~
 
 Visually the graph is
-@image html  threeNodestwoEdges_c.png
+@dot
+digraph G {
+    1 [label="1, has={2, 3}"];
+}
+@enddot
 
 
 

include/c_common/combinations_input.h

@@ -36,15 +36,10 @@ typedef struct II_t_rt II_t_rt;
 SELECT source, target
 FROM combinations_table;
 ~~~~
-
-
-@param[in] combinations_sql
-@param[out] combinations
-@param[out] combinations_edges
 */
 void pgr_get_combinations(
-        char *combinations_sql,
-        II_t_rt **combinations,
-        size_t *total_combinations);
+        char *,
+        II_t_rt **,
+        size_t *);
 
 #endif  // INCLUDE_C_COMMON_COMBINATIONS_INPUT_H_

include/circuits/hawickcircuits.hpp

@@ -42,7 +42,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 #include "cpp_common/pgr_assert.h"
 #include "c_types/circuits_rt.h"
 
-/** @file hawickcirucits.hpp
+/**
  * @brief The main file which calls the respective boost function.
  *
  * Contains actual implementation of the function and the calling
@@ -57,9 +57,8 @@ class circuit_detector{
  public:
     /** @brief circuit detector to get the results
       *
-      *
-      * @param graph     the graph containing the edges
-      * @param result    container for storing the result
+      * @param graph the graph containing the edges
+      * @param data  container for storing the result
       *
       */
     circuit_detector(

include/contraction/pgr_contractionGraph.hpp

@@ -154,17 +154,16 @@ class Pgr_contractionGraph : public Pgr_base_graph<G, CH_vertex, CH_edge> {
 
      /*! @brief add_shortuct to the graph during contraction
 
-       u -> v -> w
-
-       u -> w
-
-       edge (u, w) is a new edge e
-       e.contracted_vertices = v + v.contracted vertices
+       @param [in] edge of type *CH_edge* is to be added
+       @param [in] u vertex
+       @param [in] v vertex
 
-       removed from graph edges: u -> v  and v -> w
+       u -> w -> v
 
+       u -> v
 
-       @param [in] edge of type *CH_edge* is to be added
+       edge (u, v) is a new edge e
+       contracted_vertices = w + contracted vertices
        */
 
      void add_shortcut(const CH_edge &edge, V u, V v) {

include/cpp_common/identifiers.hpp

@@ -248,8 +248,6 @@ class Identifiers {
             os << "}";
             return os;
         }
-
-    /// @}
 };
 
 #endif  // INCLUDE_CPP_COMMON_IDENTIFIERS_HPP_

include/traversal/pgr_depthFirstSearch.hpp

@@ -116,6 +116,7 @@ class Pgr_depthFirstSearch {
       * @param root           the root vertex
       * @param visited_order  vector which will contain the edges of the resulting traversal
       * @param directed       whether the graph is directed or undirected
+      * @param max_depth      Upper limit for depth to be returned
       *
       * @returns bool  @b true, when results are found
       */

include/vrp/fleet.h

@@ -89,13 +89,8 @@ class Fleet {
      Identifiers<size_t> m_used;
      Identifiers<size_t> m_un_used;
 
-     /*! @brief build the fleet
-      *
-      * @param[in] vehicles of type Vehicle_t
-      */
-     bool build_fleet(
-             std::vector<Vehicle_t> vehicles,
-             double factor);
+     /*! @brief build the fleet */
+     bool build_fleet(std::vector<Vehicle_t>, double);
 
      void add_vehicle(
              Vehicle_t,

include/vrp/pgr_pickDeliver.h

@@ -97,7 +97,6 @@ class Pgr_pickDeliver : public PD_problem {
 
     /** message controller for all classes */
     Pgr_messages msg;
-    /** @} */
 
 
  private:

include/vrp/tw_node.h

@@ -67,7 +67,7 @@ class Tw_node : public Dnode {
 
 
      /** @name accessors */
-     ///@ {
+     ///@{
 
      /*! @brief Returns the opening time.*/
      inline int64_t order() const {return m_order;}
@@ -105,7 +105,7 @@ class Tw_node : public Dnode {
       *   - the demand are valid for the requested type
       */
 
-     ///@ {
+     ///@{
 
 
      /*! @brief is_start
@@ -187,7 +187,7 @@ class Tw_node : public Dnode {
 
 
      /** @name document functions */
-     ///@ {
+     ///@{
      /*!
       * The actual arrival time at @b This node, given that:
       * @b this node is visited directly after @b other node

include/vrp/vehicle.h

@@ -125,7 +125,7 @@ class Vehicle : public Identifier {
      void invariant() const;
 
 
-     /// @ {
+     /// @{
 
      /*! @brief Insert @b node at @b pos position.
       *
@@ -270,7 +270,7 @@ class Vehicle : public Identifier {
       *
       */
 
-     ///@ {
+     ///@{
 
      /*! @brief Evaluate: Evaluate the whole path from the start. */
      void evaluate();
@@ -288,14 +288,14 @@ class Vehicle : public Identifier {
 
 
      /*! @name accessors */
-     ///@ {
+     ///@{
 
      std::deque< Vehicle_node > path() const;
 
      ///@}
 
      /*! @name operators */
-     ///@ {
+     ///@{
 
 
      friend std::ostream& operator << (std::ostream &log, const Vehicle &v);

include/vrp/vehicle_node.h

@@ -48,15 +48,15 @@ namespace vrp {
 class Vehicle_node: public Tw_node {
  public:
      /** @name log */
-     ///@ {
+     ///@{
 
      friend std::ostream& operator<<(
              std::ostream &log, const Vehicle_node &node);
 
      ///@}
 
      /** @name Node evaluation accessors */
-     ///@ {
+     ///@{
 
      /*! \brief Truck's travel_time from previous node to this node. */
      inline double travel_time() const {return m_travel_time;}
@@ -81,7 +81,7 @@ class Vehicle_node: public Tw_node {
 
 
      /** @name Accumulated evaluation accessors */
-     ///@ {
+     ///@{
 
      /*! \brief Truck's total times it has violated time windows. */
      inline int twvTot() const {return m_twvTot;}
@@ -108,7 +108,7 @@ class Vehicle_node: public Tw_node {
 
 
      /** @name State */
-     ///@ {
+     ///@{
 
      /*! \brief True when the total count for violations are 0 */
      bool feasible() const {return m_twvTot == 0 &&  m_cvTot == 0;}
@@ -134,7 +134,7 @@ class Vehicle_node: public Tw_node {
      ///@}
 
      /** @name mutators */
-     ///@ {
+     ///@{
      /*! @todo TODO evaluate with matrix also*/
      void evaluate(double cargoLimit);
      void evaluate(const Vehicle_node &pred, double cargoLimit, double speed);
@@ -150,7 +150,7 @@ class Vehicle_node: public Tw_node {
 
  private:
      /** @name Node evaluation members */
-     ///@ {
+     ///@{
 
      double m_travel_time;     ///< Travel time from last node
      double m_arrival_time;    ///< Arrival time at this node
@@ -161,7 +161,7 @@ class Vehicle_node: public Tw_node {
      ///@}
 
      /** @name Accumulated evaluation members */
-     ///@ {
+     ///@{
 
      double m_cargo;           ///< Accumulated cargo
      int    m_twvTot;          ///< Total count of TWV