Skip to content
Permalink
Browse files

fix Doxygen warnings, documentation update

  • Loading branch information
Sergey Yakushevs
Sergey Yakushevs committed Jun 1, 2011
1 parent 2670900 commit 79f3911fe65f82f7dc50f860e6421a0ee281778e
@@ -17,3 +17,8 @@ high level tools for carrying out spatial analysis on vector and raster data.
*/

/** @defgroup MapComposer */

/** @defgroup networkanalysis QGIS network analysis library.

The network analysis library provides high level tool for build topology and analysis it.
*/
@@ -24,8 +24,10 @@
#include <qgslabel.h>

/**
* \ingroup networkanalysis
* \class QgsEdgeProperter
* \brief QgsEdgeProperter is a strategy pattern. You can use it for customize edge property.
* \brief QgsEdgeProperter is a strategy pattern.
* You can use it for customize edge property. For example look at QgsDistanceEdgeProperter or src/plugins/roadgraph/speedproperter.h
*/
class ANALYSIS_EXPORT QgsEdgeProperter
{
@@ -34,7 +34,7 @@
class QgsGraphVertex;

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

/**
* \ingroup analysis
* \ingroup networkanalysis
* \class QgsGraphVertex
* \brief This class implement a graph vertex
*/
@@ -120,7 +120,7 @@ class ANALYSIS_EXPORT QgsGraphVertex
};

/**
* \ingroup analysis
* \ingroup networkanalysis
* \class QgsGraph
* \brief Mathematics graph representation
*/
@@ -1,5 +1,5 @@
/***************************************************************************
qgsgraphalyzer.h - QGIS Tools for vector geometry analysis
qgsgraphalyzer.h - QGIS Tools for graph analysis
-------------------
begin : 14 april 2010
copyright : (C) Sergey Yakushev
@@ -24,7 +24,7 @@
// forward-declaration
class QgsGraph;

/** \ingroup analysis
/** \ingroup networkanalysis
* The QGis class provides graph analysis functions
*/

@@ -28,7 +28,7 @@ class QgsCoordinateTransform;
class QgsGraph;

/**
* \ingroup analysis
* \ingroup networkanalysis
* \class QgsGraphBuilder
* \brief This class making the QgsGraph object
*/
@@ -27,7 +27,7 @@
//forward declarations

/**
* \ingroup analysis
* \ingroup networkanalysis
* \class QgsGraphBuilderInterface
* \brief Determine interface for creating a graph. Contains the settings of the graph. QgsGraphBuilder and QgsGraphDirector is a Builder pattern
*/
@@ -28,7 +28,7 @@
class QgsGraphBuilderInterface;

/**
* \ingroup analysis
* \ingroup networkanalysis
* \class QgsGraphDirector
* \brief Determine making the graph. QgsGraphBuilder and QgsGraphDirector is a builder patter.
*/
@@ -27,7 +27,7 @@ class QgsGraphBuilderInterface;
class QgsVectorLayer;

/**
* \ingroup analysis
* \ingroup networkanalysis
* \class QgsLineVectorLayerDirector
* \brief Determine making the graph from vector line layer
*/
@@ -46,12 +46,12 @@ class QgsLineVectorLayerDirector : public QgsGraphDirector
* @param layerId
* @param directionFieldId feield contain road direction value
* @param directDirectionValue value for one-way road
* @param reverseDirection value for reverse one-way road
* @param reverseDirectionValue value for reverse one-way road
* @param bothDirectionValue value for road
* @param defaultDirection 1 - direct direction, 2 - reverse direction, 3 - both direction
*/
QgsLineVectorLayerDirector( const QString& layerId,
int directionFiledId,
int directionFieldId,
const QString& directDirectionValue,
const QString& reverseDirectionValue,
const QString& bothDirectionValue,
@@ -61,7 +61,7 @@ class QgsLineVectorLayerDirector : public QgsGraphDirector
//! Destructor
virtual ~QgsLineVectorLayerDirector();

/**
/*
* MANDATORY DIRECTOR PROPERTY DECLARATION
*/
void makeGraph( QgsGraphBuilderInterface *builder,

0 comments on commit 79f3911

Please sign in to comment.
You can’t perform that action at this time.