Skip to content

Commit

Permalink
remove word "road" from doxygen comments
Browse files Browse the repository at this point in the history
  • Loading branch information
alexbruy committed Nov 21, 2016
1 parent b421a53 commit fb5cdd8
Show file tree
Hide file tree
Showing 9 changed files with 26 additions and 23 deletions.
2 changes: 1 addition & 1 deletion python/analysis/network/qgsgraph.sip
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ class QgsGraphVertex
/**
* \ingroup analysis
* \class QgsGraph
* \brief Mathematics graph representation
* \brief Mathematical graph representation
*/

class QgsGraph
Expand Down
3 changes: 2 additions & 1 deletion python/analysis/network/qgsgraphbuilderinterface.sip
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
3 changes: 2 additions & 1 deletion python/analysis/network/qgsgraphdirector.sip
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
6 changes: 3 additions & 3 deletions python/analysis/network/qgsvectorlayerdirector.sip
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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,
Expand Down
2 changes: 1 addition & 1 deletion src/analysis/network/qgsgraph.h
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ class ANALYSIS_EXPORT QgsGraphVertex
/**
* \ingroup analysis
* \class QgsGraph
* \brief Mathematics graph representation
* \brief Mathematical graph representation
*/

class ANALYSIS_EXPORT QgsGraph
Expand Down
2 changes: 1 addition & 1 deletion src/analysis/network/qgsgraphbuilderinterface.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
3 changes: 2 additions & 1 deletion src/analysis/network/qgsgraphdirector.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
8 changes: 4 additions & 4 deletions src/analysis/network/qgsvectorlayerdirector.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@
***************************************************************************/

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

#include "qgsvectorlayerdirector.h"
Expand Down Expand Up @@ -108,7 +108,7 @@ QgsVectorLayerDirector::QgsVectorLayerDirector( QgsVectorLayer *myLayer,
const QString& reverseDirectionValue,
const QString& bothDirectionValue,
const Direction defaultDirection
)
)
{
mVectorLayer = myLayer;
mDirectionFieldId = directionFieldId;
Expand All @@ -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;

Expand Down
20 changes: 10 additions & 10 deletions src/analysis/network/qgsvectorlayerdirector.h
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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();
Expand Down

0 comments on commit fb5cdd8

Please sign in to comment.