add RoadGraphPlugin doxyfile. Fix doxygen warnings.

git-svn-id: http://svn.osgeo.org/qgis/trunk@15083 c8812cc2-4d05-0410-92ff-de0c093fc19c
qgis · Jan 26, 2011 · a33bd7e · a33bd7e
1 parent 630f434
commit a33bd7e
Show file tree

Hide file tree

Showing 9 changed files with 1,654 additions and 12 deletions.
diff --git a/src/plugins/roadgraph/Doxyfile b/src/plugins/roadgraph/Doxyfile
diff --git a/src/plugins/roadgraph/graphbuilder.h b/src/plugins/roadgraph/graphbuilder.h
@@ -27,8 +27,7 @@
 
 /**
 * \class RgGraphDirector
-* \brief Determine making the graph
-* contained the settings
+* \brief Determine making the graph, contained the settings
 */
 class RgGraphBuilder
 {
@@ -59,7 +58,7 @@ class RgGraphBuilder
     /**
      * tie point
      * @param pt maps point
-     * @param pt ok = false if tiePoint failed.
+     * @param ok ok = false if tiePoint failed.
      * @return Graph vertex corresponding pt.
      * @note: graph can be modified
      */

diff --git a/src/plugins/roadgraph/linevectorlayerdirector.cpp b/src/plugins/roadgraph/linevectorlayerdirector.cpp
@@ -10,7 +10,7 @@
  ***************************************************************************/
 
 /**
- * \file linevectorlayersettins.cpp
+ * \file linevectorlayerdirector.cpp
  * \brief implementation of RgLineVectorLayerDirector
  */
 

diff --git a/src/plugins/roadgraph/linevectorlayersettings.cpp b/src/plugins/roadgraph/linevectorlayersettings.cpp
@@ -10,7 +10,7 @@
  ***************************************************************************/
 
 /**
- * \file linevectorlayersettins.cpp
+ * \file linevectorlayersettings.cpp
  * \brief implementation of RgLineVectorLayerSettings
  */
 

diff --git a/src/plugins/roadgraph/roadgraphplugin.cpp b/src/plugins/roadgraph/roadgraphplugin.cpp
@@ -62,7 +62,7 @@ static const QgisPlugin::PLUGINTYPE sPluginType = QgisPlugin::UI;
 /**
  * Constructor for the plugin. The plugin is passed a pointer
  * an interface object that provides access to exposed functions in QGIS.
- * @param theQGisInterface - Pointer to the QGIS interface object
+ * @param theQgisInterface - Pointer to the QGIS interface object
  */
 RoadGraphPlugin::RoadGraphPlugin( QgisInterface * theQgisInterface ):
     QgisPlugin( sName, sDescription, sPluginVersion, sPluginType ),

diff --git a/src/plugins/roadgraph/roadgraphplugin.h b/src/plugins/roadgraph/roadgraphplugin.h
@@ -45,9 +45,9 @@ class RoadGraphPlugin: public QObject, public QgisPlugin
     /**
      * Constructor for a plugin. The QgisInterface pointer is passed by
      * QGIS when it attempts to instantiate the plugin.
-     * @param theInterface Pointer to the QgisInterface object.
+     * @param theQgisInterface Pointer to the QgisInterface object.
      */
-    RoadGraphPlugin( QgisInterface * theInterface );
+    RoadGraphPlugin( QgisInterface * theQgisInterface );
     //! Destructor
     virtual ~RoadGraphPlugin();
     /**

diff --git a/src/plugins/roadgraph/shortestpathwidget.cpp b/src/plugins/roadgraph/shortestpathwidget.cpp
@@ -11,7 +11,7 @@
  ***************************************************************************/
 
 /**
- * \file shortestpahtwidget.cpp
+ * \file shortestpathwidget.cpp
  * \brief implemetation UI for find shotest path
  */
 

diff --git a/src/plugins/roadgraph/simplegraphbuilder.h b/src/plugins/roadgraph/simplegraphbuilder.h
@@ -28,8 +28,7 @@ class QgsCoordinateTransform;
 
 /**
 * \class RgSimpleGraphBuilder
-* \brief This class making the simple graph for visualisation
-* contained the settings
+* \brief This class making the simple graph
 */
 
 class RgSimpleGraphBuilder : public RgGraphBuilder

diff --git a/src/plugins/roadgraph/utils.h b/src/plugins/roadgraph/utils.h
@@ -29,7 +29,6 @@
 */
 
 /**
- * \function infinity()
  * \brief return big const double value
  */
 double infinity();