Skip to content

Commit 79f3911

Browse files
committedJun 1, 2011
fix Doxygen warnings, documentation update
1 parent 2670900 commit 79f3911

File tree

8 files changed

+20
-13
lines changed

8 files changed

+20
-13
lines changed
 

‎doc/modules.dox

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,8 @@ high level tools for carrying out spatial analysis on vector and raster data.
1717
*/
1818

1919
/** @defgroup MapComposer */
20+
21+
/** @defgroup networkanalysis QGIS network analysis library.
22+
23+
The network analysis library provides high level tool for build topology and analysis it.
24+
*/

‎src/analysis/network/qgsedgeproperter.h

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,10 @@
2424
#include <qgslabel.h>
2525

2626
/**
27+
* \ingroup networkanalysis
2728
* \class QgsEdgeProperter
28-
* \brief QgsEdgeProperter is a strategy pattern. You can use it for customize edge property.
29+
* \brief QgsEdgeProperter is a strategy pattern.
30+
* You can use it for customize edge property. For example look at QgsDistanceEdgeProperter or src/plugins/roadgraph/speedproperter.h
2931
*/
3032
class ANALYSIS_EXPORT QgsEdgeProperter
3133
{

‎src/analysis/network/qgsgraph.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
class QgsGraphVertex;
3535

3636
/**
37-
* \ingroup analysis
37+
* \ingroup networkanalysis
3838
* \class QgsGraphEdge
3939
* \brief This class implement a graph edge
4040
*/
@@ -78,7 +78,7 @@ class ANALYSIS_EXPORT QgsGraphArc
7878
typedef QList< int > QgsGraphArcIdList;
7979

8080
/**
81-
* \ingroup analysis
81+
* \ingroup networkanalysis
8282
* \class QgsGraphVertex
8383
* \brief This class implement a graph vertex
8484
*/
@@ -120,7 +120,7 @@ class ANALYSIS_EXPORT QgsGraphVertex
120120
};
121121

122122
/**
123-
* \ingroup analysis
123+
* \ingroup networkanalysis
124124
* \class QgsGraph
125125
* \brief Mathematics graph representation
126126
*/

‎src/analysis/network/qgsgraphanalyzer.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/***************************************************************************
2-
qgsgraphalyzer.h - QGIS Tools for vector geometry analysis
2+
qgsgraphalyzer.h - QGIS Tools for graph analysis
33
-------------------
44
begin : 14 april 2010
55
copyright : (C) Sergey Yakushev
@@ -24,7 +24,7 @@
2424
// forward-declaration
2525
class QgsGraph;
2626

27-
/** \ingroup analysis
27+
/** \ingroup networkanalysis
2828
* The QGis class provides graph analysis functions
2929
*/
3030

‎src/analysis/network/qgsgraphbuilder.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ class QgsCoordinateTransform;
2828
class QgsGraph;
2929

3030
/**
31-
* \ingroup analysis
31+
* \ingroup networkanalysis
3232
* \class QgsGraphBuilder
3333
* \brief This class making the QgsGraph object
3434
*/

‎src/analysis/network/qgsgraphbuilderintr.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
//forward declarations
2828

2929
/**
30-
* \ingroup analysis
30+
* \ingroup networkanalysis
3131
* \class QgsGraphBuilderInterface
3232
* \brief Determine interface for creating a graph. Contains the settings of the graph. QgsGraphBuilder and QgsGraphDirector is a Builder pattern
3333
*/

‎src/analysis/network/qgsgraphdirector.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
class QgsGraphBuilderInterface;
2929

3030
/**
31-
* \ingroup analysis
31+
* \ingroup networkanalysis
3232
* \class QgsGraphDirector
3333
* \brief Determine making the graph. QgsGraphBuilder and QgsGraphDirector is a builder patter.
3434
*/

‎src/analysis/network/qgslinevectorlayerdirector.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ class QgsGraphBuilderInterface;
2727
class QgsVectorLayer;
2828

2929
/**
30-
* \ingroup analysis
30+
* \ingroup networkanalysis
3131
* \class QgsLineVectorLayerDirector
3232
* \brief Determine making the graph from vector line layer
3333
*/
@@ -46,12 +46,12 @@ class QgsLineVectorLayerDirector : public QgsGraphDirector
4646
* @param layerId
4747
* @param directionFieldId feield contain road direction value
4848
* @param directDirectionValue value for one-way road
49-
* @param reverseDirection value for reverse one-way road
49+
* @param reverseDirectionValue value for reverse one-way road
5050
* @param bothDirectionValue value for road
5151
* @param defaultDirection 1 - direct direction, 2 - reverse direction, 3 - both direction
5252
*/
5353
QgsLineVectorLayerDirector( const QString& layerId,
54-
int directionFiledId,
54+
int directionFieldId,
5555
const QString& directDirectionValue,
5656
const QString& reverseDirectionValue,
5757
const QString& bothDirectionValue,
@@ -61,7 +61,7 @@ class QgsLineVectorLayerDirector : public QgsGraphDirector
6161
//! Destructor
6262
virtual ~QgsLineVectorLayerDirector();
6363

64-
/**
64+
/*
6565
* MANDATORY DIRECTOR PROPERTY DECLARATION
6666
*/
6767
void makeGraph( QgsGraphBuilderInterface *builder,

0 commit comments

Comments
 (0)
Please sign in to comment.