Skip to content
Permalink
Browse files

remove word "road" from doxygen comments

  • Loading branch information
alexbruy committed Nov 21, 2016
1 parent b421a53 commit fb5cdd83ee2a7d013bb63385f79938890026695f
@@ -79,7 +79,7 @@ class QgsGraphVertex
/**
* \ingroup analysis
* \class QgsGraph
* \brief Mathematics graph representation
* \brief Mathematical graph representation
*/

class QgsGraph
@@ -5,7 +5,8 @@
/**
* \ingroup analysis
* \class QgsGraphBuilderInterface
* \brief Determine interface for creating a graph. Contains the settings of the graph. QgsGraphBuilder and QgsGraphDirector is a Builder pattern
* \brief Determine interface for creating a graph. Contains the settings of the graph.
* QgsGraphBuilder and QgsGraphDirector both use a "builder" design pattern
*/
class QgsGraphBuilderInterface
{
@@ -5,7 +5,8 @@
/**
* \ingroup analysis
* \class QgsGraphDirector
* \brief Determine making the graph. QgsGraphBuilder and QgsGraphDirector is a builder patter.
* \brief Determine making the graph. QgsGraphBuilder and QgsGraphDirector
* are implemented using "builder" design patter.
*/
class QgsGraphDirector : QObject
{
@@ -10,8 +10,8 @@ class QgsVectorLayerDirector : QgsGraphDirector
%End

public:
/** Road direction
* Road can be one-way with direct flow (one can move only from the start
/** Edge direction
* Edge can be one-way with direct flow (one can move only from the start
* point to the end point), one-way with reversed flow (one can move only
* from the end point to the start point) and bidirectional or two-way
* (one can move in any direction)
@@ -29,7 +29,7 @@ class QgsVectorLayerDirector : QgsGraphDirector
* @param directDirectionValue value for one-way road
* @param reverseDirectionValue value for reverse one-way road
* @param bothDirectionValue value for road
* @param defaultDirection default road direction. Will be used if corresponding
* @param defaultDirection default direction. Will be used if corresponding
* attribute value is not set or does not equal to the given values
*/
QgsVectorLayerDirector( QgsVectorLayer* myLayer,
@@ -124,7 +124,7 @@ class ANALYSIS_EXPORT QgsGraphVertex
/**
* \ingroup analysis
* \class QgsGraph
* \brief Mathematics graph representation
* \brief Mathematical graph representation
*/

class ANALYSIS_EXPORT QgsGraph
@@ -27,7 +27,7 @@
* \ingroup analysis
* \class QgsGraphBuilderInterface
* \brief Determine interface for creating a graph. Contains the settings of the graph.
* QgsGraphBuilder and QgsGraphDirector both use a Builder pattern
* QgsGraphBuilder and QgsGraphDirector both use a "builder" design pattern
*/
class ANALYSIS_EXPORT QgsGraphBuilderInterface
{
@@ -28,7 +28,8 @@ class QgsGraphBuilderInterface;
/**
* \ingroup analysis
* \class QgsGraphDirector
* \brief Determine making the graph. QgsGraphBuilder and QgsGraphDirector is a builder patter.
* \brief Determine making the graph. QgsGraphBuilder and QgsGraphDirector implemented
* using "builder" design patter.
*/
class ANALYSIS_EXPORT QgsGraphDirector : public QObject
{
@@ -14,8 +14,8 @@
***************************************************************************/

/**
* \file qgslinevectorlayerdirector.cpp
* \brief implementation of QgsLineVectorLayerDirector
* \file qgsvectorlayerdirector.cpp
* \brief implementation of QgsVectorLayerDirector
*/

#include "qgsvectorlayerdirector.h"
@@ -108,7 +108,7 @@ QgsVectorLayerDirector::QgsVectorLayerDirector( QgsVectorLayer *myLayer,
const QString& reverseDirectionValue,
const QString& bothDirectionValue,
const Direction defaultDirection
)
)
{
mVectorLayer = myLayer;
mDirectionFieldId = directionFieldId;
@@ -129,7 +129,7 @@ QString QgsVectorLayerDirector::name() const
}

void QgsVectorLayerDirector::makeGraph( QgsGraphBuilderInterface *builder, const QVector< QgsPoint >& additionalPoints,
QVector< QgsPoint >& snappedPoints ) const
QVector< QgsPoint >& snappedPoints ) const
{
QgsVectorLayer *vl = mVectorLayer;

@@ -32,8 +32,8 @@ class ANALYSIS_EXPORT QgsVectorLayerDirector : public QgsGraphDirector

public:

/** Road direction
* Road can be one-way with direct flow (one can move only from the start
/** Edge direction
* Edge can be one-way with direct flow (one can move only from the start
* point to the end point), one-way with reversed flow (one can move only
* from the end point to the start point) and bidirectional or two-way
* (one can move in any direction)
@@ -48,20 +48,20 @@ class ANALYSIS_EXPORT QgsVectorLayerDirector : public QgsGraphDirector
/**
* Default constructor
* @param myLayer source vector layer
* @param directionFieldId field contain road direction value
* @param directionFieldId field containing direction value
* @param directDirectionValue value for direct one-way road
* @param reverseDirectionValue value for reversed one-way road
* @param bothDirectionValue value for two-way (bidirectional) road
* @param defaultDirection default road direction. Will be used if corresponding
* @param defaultDirection default direction. Will be used if corresponding
* attribute value is not set or does not equal to the given values
*/
QgsVectorLayerDirector( QgsVectorLayer* myLayer,
int directionFieldId,
const QString& directDirectionValue,
const QString& reverseDirectionValue,
const QString& bothDirectionValue,
const Direction defaultDirection
);
int directionFieldId,
const QString& directDirectionValue,
const QString& reverseDirectionValue,
const QString& bothDirectionValue,
const Direction defaultDirection
);

//! Destructor
virtual ~QgsVectorLayerDirector();

0 comments on commit fb5cdd8

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