Replace "python" with "Python" in docs

qgis · Apr 2, 2017 · 32326ab · 32326ab
1 parent 1521033
commit 32326ab
Show file tree

Hide file tree

Showing 104 changed files with 268 additions and 268 deletions.
diff --git a/src/analysis/interpolation/DualEdgeTriangulation.h b/src/analysis/interpolation/DualEdgeTriangulation.h
@@ -59,7 +59,7 @@ class ANALYSIS_EXPORT DualEdgeTriangulation: public Triangulation
     //! Returns the number of the point opposite to the triangle points p1, p2 (which have to be on a halfedge)
     int getOppositePoint( int p1, int p2 ) override;
     //! Finds out, in which triangle the point with coordinates x and y is and assigns the numbers of the vertices to 'n1', 'n2' and 'n3' and the vertices to 'p1', 'p2' and 'p3'
-    //! @note not available in python bindings
+    //! @note not available in Python bindings
     virtual bool getTriangle( double x, double y, Point3D *p1, int *n1, Point3D *p2, int *n2, Point3D *p3, int *n3 ) override;
     //! Finds out, in which triangle the point with coordinates x and y is and assigns addresses to the points at the vertices to 'p1', 'p2' and 'p3
     virtual bool getTriangle( double x, double y, Point3D *p1, Point3D *p2, Point3D *p3 ) override;

diff --git a/src/analysis/raster/qgsrastermatrix.h b/src/analysis/raster/qgsrastermatrix.h
@@ -60,7 +60,7 @@ class ANALYSIS_EXPORT QgsRasterMatrix
 
     //! Takes ownership of data array
     QgsRasterMatrix();
-    //! @note note available in python bindings
+    //! @note note available in Python bindings
     QgsRasterMatrix( int nCols, int nRows, double *data, double nodataValue );
     QgsRasterMatrix( const QgsRasterMatrix &m );
     ~QgsRasterMatrix();
@@ -70,10 +70,10 @@ class ANALYSIS_EXPORT QgsRasterMatrix
     double number() const { return mData[0]; }
 
     //! Returns data array (but not ownership)
-    //! @note not available in python bindings
+    //! @note not available in Python bindings
     double *data() { return mData; }
     //! Returns data and ownership. Sets data and nrows, ncols of this matrix to 0
-    //! @note not available in python bindings
+    //! @note not available in Python bindings
     double *takeData();
 
     void setData( int cols, int rows, double *data, double nodataValue );

diff --git a/src/app/pluginmanager/qgsapppluginmanagerinterface.h b/src/app/pluginmanager/qgsapppluginmanagerinterface.h
@@ -36,7 +36,7 @@ class QgsAppPluginManagerInterface : public QgsPluginManagerInterface
 
     ~QgsAppPluginManagerInterface();
 
-    //! remove python plugins from the metadata registry (c++ plugins stay)
+    //! remove Python plugins from the metadata registry (c++ plugins stay)
     void clearPythonPluginMetadata() override;
 
     //! add a single plugin to the metadata registry

diff --git a/src/app/pluginmanager/qgspluginmanager.h b/src/app/pluginmanager/qgspluginmanager.h
@@ -52,7 +52,7 @@ class QgsPluginManager : public QgsOptionsDialogBase, private Ui::QgsPluginManag
 
     ~QgsPluginManager();
 
-    //! Save pointer to python utils and enable Python support
+    //! Save pointer to Python utils and enable Python support
     void setPythonUtils( QgsPythonUtils *pythonUtils );
 
     //! Load selected plugin
@@ -76,7 +76,7 @@ class QgsPluginManager : public QgsOptionsDialogBase, private Ui::QgsPluginManag
     //! Fill the html browser widget with plugin details
     void showPluginDetails( QStandardItem *item );
 
-    //! Remove python plugins from the metadata registry (c++ plugins stay)
+    //! Remove Python plugins from the metadata registry (c++ plugins stay)
     void clearPythonPluginMetadata();
 
     //! Add a single plugin to the metadata registry

diff --git a/src/app/qgisapp.h b/src/app/qgisapp.h
@@ -941,7 +941,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
     void decreaseContrast();
     //! plugin manager
     void showPluginManager();
-    //! load python support if possible
+    //! load Python support if possible
     void loadPythonSupport();
 
     /** Install plugin from ZIP file
@@ -1068,8 +1068,8 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
     //! text)= of the given action.
     void openProject( QAction *action );
 
-    /** Attempts to run a python script
-     * @param filePath full path to python script
+    /** Attempts to run a Python script
+     * @param filePath full path to Python script
      * @note added in QGIS 2.7
      */
     void runScript( const QString &filePath );
@@ -1353,7 +1353,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
     //! save current raster layer
     void saveAsRasterFile();
 
-    //! show python console
+    //! show Python console
     void showPythonDialog();
 
     //! Shows a warning when an old project file is read.

diff --git a/src/app/qgspluginregistry.h b/src/app/qgspluginregistry.h
@@ -67,7 +67,7 @@ class APP_EXPORT QgsPluginRegistry
     //! Unload plugins
     void unloadAll();
 
-    //! Save pointer for python utils (needed for unloading python plugins)
+    //! Save pointer for Python utils (needed for unloading Python plugins)
     void setPythonUtils( QgsPythonUtils *pythonUtils );
 
     //! Dump list of plugins

diff --git a/src/app/qgsprojectproperties.h b/src/app/qgsprojectproperties.h
@@ -191,7 +191,7 @@ class APP_EXPORT QgsProjectProperties : public QgsOptionsDialogBase, private Ui:
     void restoreState();
 
     /*!
-     * Reset the python macros
+     * Reset the Python macros
      */
     void resetPythonMacros();
 

diff --git a/src/core/composer/qgscomposerattributetablev2.h b/src/core/composer/qgscomposerattributetablev2.h
@@ -269,7 +269,7 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2
      * @returns a QList of integer/bool pairs, where the integer refers to the attribute index and
      * the bool to the sort order for the attribute. If true the attribute is sorted ascending,
      * if false, the attribute is sorted in descending order.
-     * @note not available in python bindings
+     * @note not available in Python bindings
      */
     QList<QPair<int, bool> > sortAttributes() const;
 
@@ -292,7 +292,7 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2
     /** Queries the attribute table's vector layer for attributes to show in the table.
      * @param contents table content
      * @returns true if attributes were successfully fetched
-     * @note not available in python bindings
+     * @note not available in Python bindings
      */
     bool getTableContents( QgsComposerTableContents &contents ) override;
 

diff --git a/src/core/composer/qgscomposermap.h b/src/core/composer/qgscomposermap.h
@@ -165,7 +165,7 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
      */
     const QgsRectangle *currentMapExtent() const;
 
-    //! @note not available in python bindings
+    //! @note not available in Python bindings
     QgsRectangle *currentMapExtent();
 
     /**

diff --git a/src/core/composer/qgscomposermapgrid.h b/src/core/composer/qgscomposermapgrid.h
@@ -487,7 +487,7 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
      * @see setLineSymbol
      * @see markerSymbol
      * @see style
-     * @note not available in python bindings
+     * @note not available in Python bindings
      */
     const QgsLineSymbol *lineSymbol() const { return mGridLineSymbol; }
 
@@ -515,7 +515,7 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
      * @see setMarkerSymbol
      * @see lineSymbol
      * @see style
-     * @note not available in python bindings
+     * @note not available in Python bindings
      */
     const QgsMarkerSymbol *markerSymbol() const { return mGridMarkerSymbol; }
 

diff --git a/src/core/composer/qgscomposermapitem.h b/src/core/composer/qgscomposermapitem.h
@@ -234,7 +234,7 @@ class CORE_EXPORT QgsComposerMapItemStack
      * @returns reference to item if found
      * @see constItem
      * @see item
-     * @note not available in python bindings
+     * @note not available in Python bindings
      */
     QgsComposerMapItem &operator[]( int idx );
 

diff --git a/src/core/composer/qgscomposermapoverview.h b/src/core/composer/qgscomposermapoverview.h
@@ -192,7 +192,7 @@ class CORE_EXPORT QgsComposerMapOverview : public QgsComposerMapItem
     /** Gets the fill symbol used for drawing the overview extent.
      * @returns fill symbol for overview
      * @see setFrameSymbol
-     * @note not available in python bindings
+     * @note not available in Python bindings
      */
     const QgsFillSymbol *frameSymbol() const { return mFrameSymbol; }
 

diff --git a/src/core/composer/qgscomposerobject.h b/src/core/composer/qgscomposerobject.h
@@ -115,7 +115,7 @@ class CORE_EXPORT QgsComposerObject: public QObject, public QgsExpressionContext
      */
     const QgsComposition *composition() const { return mComposition; }
 
-    //! @note not available in python bindings
+    //! @note not available in Python bindings
     QgsComposition *composition() { return mComposition; }
 
     /** Stores item state in DOM element

diff --git a/src/core/composer/qgscomposertablev2.h b/src/core/composer/qgscomposertablev2.h
@@ -440,14 +440,14 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame
     /** Returns the text used in the column headers for the table.
      * @returns QMap of int to QString, where the int is the column index (starting at 0),
      * and the string is the text to use for the column's header
-     * @note not available in python bindings
+     * @note not available in Python bindings
      */
     virtual QMap<int, QString> headerLabels() const;
 
     /** Fetches the contents used for the cells in the table.
      * @returns true if table contents were successfully retrieved.
      * @param contents QgsComposerTableContents to store retrieved row data in
-     * @note not available in python bindings
+     * @note not available in Python bindings
      */
     virtual bool getTableContents( QgsComposerTableContents &contents ) = 0;
 
@@ -619,10 +619,10 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame
      * table, then the default row height will be used for the remaining rows.
      * @param hasHeader set to true if table frame includes header cells
      * @param mergeCells set to true to merge table content cells
-     * @note not available in python bindings
+     * @note not available in Python bindings
      * @see drawVerticalGridLines
      * @see calculateMaxColumnWidths
-     * @note not available in python bindings
+     * @note not available in Python bindings
      * @note added in QGIS 2.12
      */
     void drawVerticalGridLines( QPainter *painter, const QMap<int, double> &maxWidthMap, int firstRow, int lastRow, bool hasHeader, bool mergeCells = false ) const;

diff --git a/src/core/composer/qgscomposition.h b/src/core/composer/qgscomposition.h
@@ -384,20 +384,20 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
     QList<QgsComposerItem *> selectedComposerItems( const bool includeLockedItems = true );
 
     /** Returns pointers to all composer maps in the scene
-      @note available in python bindings only with PyQt >= 4.8.4
+      @note available in Python bindings only with PyQt >= 4.8.4
       */
     QList<const QgsComposerMap *> composerMapItems() const;
 
     /** Return composer items of a specific type
      * @param itemList list of item type to store matching items in
-     * @note not available in python bindings
+     * @note not available in Python bindings
      */
     template<class T> void composerItems( QList<T *> &itemList );
 
     /** Return composer items of a specific type on a specified page
      * @param itemList list of item type to store matching items in
      * @param pageNumber page number (0 based)
-     * @note not available in python bindings
+     * @note not available in Python bindings
      * @note added in QGIS 2.5
      */
     template<class T> void composerItemsOnPage( QList<T *> &itemList, const int pageNumber ) const;
@@ -487,7 +487,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
      * @param addUndoCommands insert AddItem commands if true (e.g. for copy/paste)
      * @param pos item position. Optional, take position from xml if 0
      * @param pasteInPlace whether the position should be kept but mapped to the page origin. (the page is the page under to the mouse cursor)
-     * @note parameters mapsToRestore, addUndoCommands pos and pasteInPlace not available in python bindings
+     * @note parameters mapsToRestore, addUndoCommands pos and pasteInPlace not available in Python bindings
      */
     void addItemsFromXml( const QDomElement &elem, const QDomDocument &doc,
                           bool addUndoCommands = false, QPointF *pos = nullptr, bool pasteInPlace = false );
@@ -559,7 +559,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
     QList< QGraphicsLineItem * > *snapLines() {return &mSnapLines;}
 
     /** Returns pointer to selection handles
-     * @note not available in python bindings
+     * @note not available in Python bindings
      */
     QgsComposerMouseHandles *selectionHandles() {return mSelectionHandles;}
 
@@ -569,7 +569,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
     void removeSnapLine( QGraphicsLineItem *line );
 
     /** Get nearest snap line
-     * @note not available in python bindings
+     * @note not available in Python bindings
      */
     QGraphicsLineItem *nearestSnapLine( const bool horizontal, const double x, const double y, const double tolerance, QList< QPair< QgsComposerItem *, QgsComposerItem::ItemPositionMode > > &snappedItems ) const;
 
@@ -596,7 +596,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
     void removeMultiFrame( QgsComposerMultiFrame *multiFrame );
 
     /** Adds an arrow item to the graphics scene and advises composer to create a widget for it (through signal)
-      @note not available in python bindings*/
+      @note not available in Python bindings*/
     void addComposerArrow( QgsComposerArrow *arrow );
     //! Adds label to the graphics scene and advises composer to create a widget for it (through signal)
     void addComposerLabel( QgsComposerLabel *label );

diff --git a/src/core/dxf/qgsdxfexport.h b/src/core/dxf/qgsdxfexport.h
@@ -176,15 +176,15 @@ class CORE_EXPORT QgsDxfExport
      * Write a tuple of group code and integer value
      * @param code group code
      * @param i integer value
-     * @note available in python bindings as writeGroupInt
+     * @note available in Python bindings as writeGroupInt
      */
     void writeGroup( int code, int i );
 
     /**
      * Write a group code with a floating point value
      * @param code group code
      * @param d floating point value
-     * @note available in python bindings as writeGroupDouble
+     * @note available in Python bindings as writeGroupDouble
      */
     void writeGroup( int code, double d );
 
@@ -199,7 +199,7 @@ class CORE_EXPORT QgsDxfExport
      * Write a group code with a point
      * @param code group code
      * @param p point value
-     * @note available in python bindings as writeGroupPointV2
+     * @note available in Python bindings as writeGroupPointV2
      * @note added in 2.15
      */
     void writeGroup( int code, const QgsPointV2 &p );
@@ -210,7 +210,7 @@ class CORE_EXPORT QgsDxfExport
      * @param exactMatch group code to use if the color has an exact match in the dxf palette
      * @param rgbCode group code to use if the color doesn't have an exact match or has a transparency component
      * @param transparencyCode group code to use for transparency component
-     * @note available in python bindings as writeGroupPoint
+     * @note available in Python bindings as writeGroupPoint
      */
     void writeGroup( const QColor &color, int exactMatch = 62, int rgbCode = 420, int transparencyCode = 440 );
 

diff --git a/src/core/effects/qgspainteffectregistry.h b/src/core/effects/qgspainteffectregistry.h
@@ -95,7 +95,7 @@ class CORE_EXPORT QgsPaintEffectMetadata : public QgsPaintEffectAbstractMetadata
      * @param visibleName user visible name representing paint effect class
      * @param pfCreate paint effect creation function
      * @param pfWidget widget creation function
-     * @note not available in python bindings
+     * @note not available in Python bindings
      */
     QgsPaintEffectMetadata( const QString &name, const QString &visibleName,
                             QgsPaintEffectCreateFunc pfCreate,
@@ -107,35 +107,35 @@ class CORE_EXPORT QgsPaintEffectMetadata : public QgsPaintEffectAbstractMetadata
 
     /** Returns the paint effect creation function for the paint effect class
      * @returns creation function
-     * @note not available in python bindings
+     * @note not available in Python bindings
      */
     QgsPaintEffectCreateFunc createFunction() const { return mCreateFunc; }
 
     /** Returns the paint effect properties widget creation function for the paint effect class
      * @returns widget creation function
-     * @note not available in python bindings
+     * @note not available in Python bindings
      * @see setWidgetFunction
      */
     QgsPaintEffectWidgetFunc widgetFunction() const { return mWidgetFunc; }
 
     /** Sets the paint effect properties widget creation function for the paint effect class
      * @param f widget creation function
-     * @note not available in python bindings
+     * @note not available in Python bindings
      * @see widgetFunction
      */
     void setWidgetFunction( QgsPaintEffectWidgetFunc f ) { mWidgetFunc = f; }
 
     /** Creates a new paint effect of the metadata's effect class
      * @param map string map of effect properties
      * @returns new paint effect
-     * @note not available in python bindings
+     * @note not available in Python bindings
      * @see createWidget
      */
     virtual QgsPaintEffect *createPaintEffect( const QgsStringMap &map ) override { return mCreateFunc ? mCreateFunc( map ) : nullptr; }
 
     /** Creates a new paint effect properties widget for the metadata's effect class
      * @returns effect properties widget
-     * @note not available in python bindings
+     * @note not available in Python bindings
      * @see createWidget
      */
     virtual QgsPaintEffectWidget *createWidget() override { return mWidgetFunc ? mWidgetFunc() : nullptr; }