Skip to content
Permalink
Browse files

doxygen: add new directories and fix warnings

  • Loading branch information
jef-n committed Jul 13, 2014
1 parent 8650597 commit 9ce0ea3f653b0db411256af7e12e8d0c0ad85bec
@@ -573,13 +573,24 @@ WARN_LOGFILE =
INPUT = @CMAKE_SOURCE_DIR@/doc \
@CMAKE_SOURCE_DIR@/src/core \
@CMAKE_SOURCE_DIR@/src/core/composer \
@CMAKE_SOURCE_DIR@/src/core/diagram \
@CMAKE_SOURCE_DIR@/src/core/dxf \
@CMAKE_SOURCE_DIR@/src/core/gps \
@CMAKE_SOURCE_DIR@/src/core/layertree \
@CMAKE_SOURCE_DIR@/src/core/pal \
@CMAKE_SOURCE_DIR@/src/core/raster \
@CMAKE_SOURCE_DIR@/src/core/symbology-ng \
@CMAKE_SOURCE_DIR@/src/core/gps \
@CMAKE_SOURCE_DIR@/src/gui \
@CMAKE_SOURCE_DIR@/src/gui/attributetable \
@CMAKE_SOURCE_DIR@/src/gui/editorwidgets \
@CMAKE_SOURCE_DIR@/src/gui/editorwidgets/core \
@CMAKE_SOURCE_DIR@/src/gui/layertree \
@CMAKE_SOURCE_DIR@/src/gui/raster \
@CMAKE_SOURCE_DIR@/src/gui/symbology-ng \
@CMAKE_SOURCE_DIR@/src/analysis \
@CMAKE_SOURCE_DIR@/src/analysis/interpolation \
@CMAKE_SOURCE_DIR@/src/analysis/network \
@CMAKE_SOURCE_DIR@/src/analysis/openstreetmap \
@CMAKE_SOURCE_DIR@/src/analysis/raster \
@CMAKE_SOURCE_DIR@/src/analysis/vector \
@CMAKE_SOURCE_DIR@/src/plugins
@@ -484,7 +484,7 @@ class CORE_EXPORT QgsComposerItem: public QObject, public QGraphicsRectItem
* @param active true if data defined property is active, false if it is disabled
* @param useExpression true if the expression should be used
* @param expression expression for data defined property
* @field field name if the data defined property should take its value from a field
* @param field field name if the data defined property should take its value from a field
* @note this method was added in version 2.5
*/
void setDataDefinedProperty( DataDefinedProperty property, bool active, bool useExpression, const QString &expression, const QString &field );
@@ -473,8 +473,8 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene

/**Print on a preconfigured printer
* @param printer QPrinter destination
* @painter QPainter source
* @startNewPage set to true to begin the print on a new page
* @param painter QPainter source
* @param startNewPage set to true to begin the print on a new page
*/
void doPrint( QPrinter& printer, QPainter& painter, bool startNewPage = false );

@@ -527,7 +527,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene
* @param active true if data defined property is active, false if it is disabled
* @param useExpression true if the expression should be used
* @param expression expression for data defined property
* @field field name if the data defined property should take its value from a field
* @param field field name if the data defined property should take its value from a field
* @note this method was added in version 2.5
*/
void setDataDefinedProperty( QgsComposerItem::DataDefinedProperty property, bool active, bool useExpression, const QString &expression, const QString &field );
@@ -35,11 +35,11 @@ class CORE_EXPORT QgsLayerTreeUtils
{
public:

//! Try to load layer tree from <legend> tag from project files from QGIS 2.2 and below
//! Try to load layer tree from \verbatim <legend> \endverbatim tag from project files from QGIS 2.2 and below
static bool readOldLegend( QgsLayerTreeGroup* root, const QDomElement& legendElem );
//! Try to load custom layer order from <legend> tag from project files from QGIS 2.2 and below
//! Try to load custom layer order from \verbatim <legend> \endverbatim tag from project files from QGIS 2.2 and below
static bool readOldLegendLayerOrder( const QDomElement& legendElem, bool& hasCustomOrder, QStringList& order );
//! Return <legend> tag used in QGIS 2.2 and below
//! Return \verbatim <legend> \endverbatim tag used in QGIS 2.2 and below
static QDomElement writeOldLegend( QDomDocument& doc, QgsLayerTreeGroup* root, bool hasCustomOrder, const QStringList& order );

//! Convert Qt::CheckState to QString
@@ -157,6 +157,7 @@ namespace pal
* \brief create a new generic feature
*
* \param feat a pointer for a Feat which contains the spatial entites
* \param geom a pointer to a GEOS geometry
*/
FeaturePart( Feature *feat, const GEOSGeometry* geom );

@@ -210,7 +211,7 @@ namespace pal
*/
int setPositionForPolygon( double scale, LabelPosition ***lPos, PointSet *mapShape, double delta_width );


#if 0
/**
* \brief Feature against problem bbox
* \param bbox[0] problem x min
@@ -219,14 +220,15 @@ namespace pal
* \param bbox[3] problem y max
* return A set of feature which are in the bbox or null if the feature is in the bbox
*/
//LinkedList<Feature*> *splitFeature( double bbox[4]);
LinkedList<Feature*> *splitFeature( double bbox[4]);


/**
* \brief return the feature id
* \return the feature id
*/
//int getId();
int getId();
#endif

/**
* \brief return the feature
@@ -262,7 +264,6 @@ namespace pal
* \param bbox_max max values of the map extent
* \param mapShape generate candidates for this spatial entites
* \param candidates index for candidates
* \param svgmap svg map file
* \return the number of candidates in *lPos
*/
int setPosition( double scale, LabelPosition ***lPos, double bbox_min[2], double bbox_max[2], PointSet *mapShape, RTree<LabelPosition*, double, 2, double>*candidates
@@ -96,6 +96,7 @@ namespace pal
* \param alpha rotation in rad
* \param cost geographic cost
* \param feature labelpos owners
* \param isReversed label is reversed
*/
LabelPosition( int id, double x1, double y1,
double w, double h,
@@ -60,7 +60,7 @@ namespace pal
*
* a layer is a bog of feature with some data which influence the labelling process
*
* \author Maxence Laurent <maxence _dot_ laurent _at_ heig-vd _dot_ ch>
* \author Maxence Laurent (maxence _dot_ laurent _at_ heig-vd _dot_ ch)
*/
class CORE_EXPORT Layer
{
@@ -303,9 +303,10 @@ namespace pal
* \brief register a feature in the layer
*
* @param geom_id unique identifier
* @param userGeom user's geometry that implements the PalGeometry interface
* @param label_x label width
* @param label_y label height
* @param userGeom user's geometry that implements the PalGeometry interface
* @param labelText label text
* @param labelPosX x position of the label (in case of fixed label position)
* @param labelPosY y position of the label (in case of fixed label position)
* @param fixedPos true if a single fixed position for this label is needed
@@ -256,7 +256,7 @@ namespace pal
if ( !context->layer->isScaleValid( context->scale ) )
return true;

// is the feature well defined ? // TODO Check epsilon
// is the feature well defined ? TODO Check epsilon
if ( ft_ptr->getLabelWidth() < 0.0000001 || ft_ptr->getLabelHeight() < 0.0000001 )
return true;

@@ -337,17 +337,17 @@ namespace pal


/**
* \Brief Problem Factory
* \brief Problem Factory
* Select features from user's choice layers within
* a specific bounding box
* param nbLayers # wanted layers
* param layersFactor layers importance
* param layersName layers in problem
* param lambda_min west bbox
* param phi_min south bbox
* param lambda_max east bbox
* param phi_max north bbox
* param scale the scale
* @param nbLayers # wanted layers
* @param layersFactor layers importance
* @param layersName layers in problem
* @param lambda_min west bbox
* @param phi_min south bbox
* @param lambda_max east bbox
* @param phi_max north bbox
* @param scale the scale
*/
Problem* Pal::extract( int nbLayers, char **layersName, double *layersFactor, double lambda_min, double phi_min, double lambda_max, double phi_max, double scale, std::ofstream *svgmap )
{
@@ -42,7 +42,6 @@
// TODO ${MAJOR} ${MINOR} etc instead of 0.2

/**
* \mainpage Pal Libray
*
* \section intro_sec Introduction
*
@@ -89,7 +88,7 @@ namespace pal

/** The way to arrange labels against spatial entities
*
* \image html arrangement.png "Arrangement modes" width=7cm
* image html arrangement.png "Arrangement modes" width=7cm
* */
enum _arrangement
{
@@ -119,7 +118,7 @@ namespace pal
* A pal object will contains layers and global information such as which search method
* will be used, the map resolution (dpi) ....
*
* \author Maxence Laurent <maxence _dot_ laurent _at_ heig-vd _dot_ ch>
* \author Maxence Laurent (maxence _dot_ laurent _at_ heig-vd _dot_ ch)
*/
class CORE_EXPORT Pal
{
@@ -116,6 +116,7 @@ class GUI_EXPORT QgsEditorWidgetFactory
* @param vl The vector layer.
* @param fieldIdx The index of the field.
* @param config The editor widget config.
* @param cache The editor widget cache.
* @param value The value to represent.
*
* @return By default the string representation of the provided value as implied by the field definition is returned.
@@ -51,6 +51,7 @@ class GUI_EXPORT QgsEditorWidgetRegistry : public QObject
* @param config A configuration which should be used for the widget creation
* @param editor An editor widget which will be used instead of an autocreated widget
* @param parent The parent which will be used for the created wrapper and the created widget
* @param context The editor context
*
* @return A new widget wrapper
*/
@@ -115,13 +116,13 @@ class GUI_EXPORT QgsEditorWidgetRegistry : public QObject
/**
* Read all old-style editor widget configuration from a map node. Will update
* a project file to the new version on next save
* @param mapLayer The layer in question
* @param vl The layer in question
* @param layerElem The layer element from the project file
* @param cfg Writable config element
*
* @deprecated
*/
Q_DECL_DEPRECATED const QString readLegacyConfig( QgsVectorLayer* vl, const QDomElement& editTypeElement , QgsEditorWidgetConfig& cfg );
Q_DECL_DEPRECATED const QString readLegacyConfig( QgsVectorLayer* vl, const QDomElement& layerElem, QgsEditorWidgetConfig& cfg );

/**
* Write all the widget config to a layer XML node
@@ -108,7 +108,7 @@ class GUI_EXPORT QgsEditorWidgetWrapper : public QgsWidgetWrapper
/**
* Will be called when the feature changes
*
* Is forwarded to the slot @link{setValue()}
* Is forwarded to the slot \link setValue() \endlink
*
* @param feature The new feature
*/
@@ -145,7 +145,7 @@ class GUI_EXPORT QgsWidgetWrapper : public QObject
* Is called, when the value of the widget needs to be changed. Update the widget representation
* to reflect the new value.
*
* @param value The new value of the attribute
* @param feature The new feature
*/
virtual void setFeature( const QgsFeature& feature ) = 0;

@@ -39,7 +39,7 @@ class QgsLayerTreeNode;
* in advanced cases where the grouping in layer tree should be independent from the actual
* order in the canvas.
*
* @added in 2.4
* @note added in 2.4
*/
class GUI_EXPORT QgsLayerTreeMapCanvasBridge : public QObject
{
@@ -38,7 +38,8 @@ class GUI_EXPORT QgsSymbolLayerV2Widget : public QWidget
const QgsVectorLayer* mVectorLayer;
/** Get label for data defined entry.
* Implemented only for 'size' of marker symbols
* @added in 2.1 */
* @note added in 2.1
*/
virtual QString dataDefinedPropertyLabel( const QString &entryName );

signals:

0 comments on commit 9ce0ea3

Please sign in to comment.