Skip to content
Permalink
Browse files

Remove TODO comments included in public API documentation

This is just "airing our dirty laundry". We don't want/need end users
to see this.
  • Loading branch information
nyalldawson committed Jun 15, 2020
1 parent 83bcbc5 commit 8d4f00b0afc0309319c24961784419af6f50188b
@@ -41,6 +41,8 @@ Removes and deletes all the entries.





void setMapSettings( const QgsMapSettings &settings );
%Docstring
Sets the map ``settings`` associated with the labeling run.
@@ -775,11 +775,12 @@ Data item that can be used to report problems (e.g. network error)
};



class QgsDirectoryParamWidget : QTreeWidget
{
%Docstring

TODO: move to qgis_gui for QGIS 4
Browser parameter widget implementation for directory items.
%End

%TypeHeaderCode
@@ -312,7 +312,6 @@ An example url is "/home/user/data/holiday.gpx?type=route"

Provider to display vector data in a GRASS GIS layer.

TODO QGIS3: Remove virtual from non-inherited methods (like isModified)

.. seealso:: :py:class:`QgsVectorLayerUtils`
%End
@@ -276,9 +276,8 @@ if point is outside data source extent.
:return: QgsRaster.IdentifyFormatValue: map of values for each band, keys are band numbers
(from 1).
QgsRaster.IdentifyFormatFeature: map of QgsRasterFeatureList for each sublayer
(WMS) - TODO: it is not consistent with QgsRaster.IdentifyFormatValue.
QgsRaster.IdentifyFormatHtml: map of HTML strings for each sublayer (WMS).
Empty if failed or there are no results (TODO: better error reporting).
Empty if failed or there are no results.

.. note::

@@ -794,8 +794,7 @@ Returns the QgsSmartConditionMap for the given id

QString smartgroupOperator( int id );
%Docstring
Returns the operator for the smartgroup
clumsy implementation TODO create a class for smartgroups
Returns the operator for the smartgroup.
%End

QStringList symbolsOfSmartgroup( StyleEntity type, int id );
@@ -78,8 +78,6 @@ not allowed.
%Docstring
An additional expression to further restrict the available features.
This can be used to integrate additional spatial or other constraints.

TODO!
%End

QVariant identifierValue() const /Deprecated/;
@@ -998,10 +998,9 @@ Emitted when canvas background color changes
%End



void renderComplete( QPainter * );
%Docstring
TODO: deprecate when decorations are reimplemented as map canvas items

- anything related to rendering progress is not visible outside of map canvas
- additional drawing shall be done directly within the renderer job or independently as a map canvas item
%End
@@ -63,17 +63,19 @@ class CORE_EXPORT QgsLabelSearchTree
*/
Q_DECL_DEPRECATED void clear() SIP_DEPRECATED;

//TODO: why does this break bindings with QList<QgsLabelPosition>?

/**
* Returns label position(s) at a given point. QgsLabelSearchTree keeps ownership, don't delete the LabelPositions
* \note not available in Python bindings
* TODO: why does this break bindings with QList<QgsLabelPosition>?
*/
void label( const QgsPointXY &p, QList<QgsLabelPosition *> &posList ) const SIP_SKIP;

//TODO: why does this break bindings with QList<QgsLabelPosition>?

/**
* Returns label position(s) in given rectangle. QgsLabelSearchTree keeps ownership, don't delete the LabelPositions
* \note not available in Python bindings
* TODO: why does this break bindings with QList<QgsLabelPosition>?
*/
void labelsInRect( const QgsRectangle &r, QList<QgsLabelPosition *> &posList ) const SIP_SKIP;

@@ -778,11 +778,13 @@ class CORE_EXPORT QgsErrorItem : public QgsDataItem

// ---------

// TODO: move to qgis_gui for QGIS 4

/**
* \ingroup core
* \class QgsDirectoryParamWidget
*
* TODO: move to qgis_gui for QGIS 4
* Browser parameter widget implementation for directory items.
*/
class CORE_EXPORT QgsDirectoryParamWidget : public QTreeWidget
{
@@ -84,6 +84,7 @@ class QgsVectorLayerTemporalProperties;
typedef QList<int> QgsAttributeList;
typedef QSet<int> QgsAttributeIds;

// TODO QGIS4: Remove virtual from non-inherited methods (like isModified)

/**
* \ingroup core
@@ -379,7 +380,6 @@ typedef QSet<int> QgsAttributeIds;
*
* Provider to display vector data in a GRASS GIS layer.
*
* TODO QGIS3: Remove virtual from non-inherited methods (like isModified)
* \see QgsVectorLayerUtils()
*/
class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionContextGenerator, public QgsExpressionContextScopeGenerator, public QgsFeatureSink, public QgsFeatureSource
@@ -245,7 +245,9 @@ QString QgsRasterDataProvider::htmlMetadata()
return s;
}

// Default implementation for values
// TODO
// (WMS) IdentifyFormatFeature is not consistent with QgsRaster::IdentifyFormatValue.
// IdentifyFormatHtml: better error reporting
QgsRasterIdentifyResult QgsRasterDataProvider::identify( const QgsPointXY &point, QgsRaster::IdentifyFormat format, const QgsRectangle &boundingBox, int width, int height, int /*dpi*/ )
{
QgsDebugMsgLevel( QStringLiteral( "Entered" ), 4 );
@@ -365,9 +365,8 @@ class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider, public QgsRast
* \return QgsRaster::IdentifyFormatValue: map of values for each band, keys are band numbers
* (from 1).
* QgsRaster::IdentifyFormatFeature: map of QgsRasterFeatureList for each sublayer
* (WMS) - TODO: it is not consistent with QgsRaster::IdentifyFormatValue.
* QgsRaster::IdentifyFormatHtml: map of HTML strings for each sublayer (WMS).
* Empty if failed or there are no results (TODO: better error reporting).
* Empty if failed or there are no results.
* \note The arbitraryness of the returned document is enforced by WMS standards
* up to at least v1.3.0
* \see sample(), which is much more efficient for simple "value at point" queries.
@@ -786,8 +786,7 @@ class CORE_EXPORT QgsStyle : public QObject
QgsSmartConditionMap smartgroup( int id );

/**
* Returns the operator for the smartgroup
* clumsy implementation TODO create a class for smartgroups
* Returns the operator for the smartgroup.
*/
QString smartgroupOperator( int id );

@@ -100,8 +100,6 @@ class GUI_EXPORT QgsFeatureListComboBox : public QComboBox
/**
* An additional expression to further restrict the available features.
* This can be used to integrate additional spatial or other constraints.
*
* TODO!
*/
void setFilterExpression( const QString &filterExpression );

@@ -914,9 +914,9 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView
*
*/

// TODO: deprecate when decorations are reimplemented as map canvas items

/**
* TODO: deprecate when decorations are reimplemented as map canvas items
*
* - anything related to rendering progress is not visible outside of map canvas
* - additional drawing shall be done directly within the renderer job or independently as a map canvas item
*/

0 comments on commit 8d4f00b

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