Skip to content
Permalink
Browse files

Improve documentation of QgsRasterLayer constructor

 - baseName is just passed on to the parent constructor to be the display
   name, use a literal string in the example to avoid misunderstanding.

 - Remove stray bullet.
  • Loading branch information
cjmayo authored and nyalldawson committed Aug 23, 2018
1 parent 51ec333 commit 2a72eda5142b54dde60244b5dab3ec5db8441680
Showing with 1 addition and 6 deletions.
  1. +0 −2 python/core/auto_generated/raster/qgsrasterlayer.sip.in
  2. +1 −4 src/core/raster/qgsrasterlayer.h
@@ -130,8 +130,6 @@ The main tasks carried out by the constructor are:
-Determine whether the layer is gray, paletted or multiband.

-Assign sensible defaults for the red, green, blue and gray bands.

-
%End

~QgsRasterLayer();
@@ -93,8 +93,7 @@ typedef QList < QPair< QString, QColor > > QgsLegendColorList;
*
* \code{.cpp}
* QString myFileNameQString = "/path/to/file";
* QFileInfo myFileInfo(myFileNameQString);
* QString myBaseNameQString = myFileInfo.baseName();
* QString myBaseNameQString = "my layer";
* QgsRasterLayer *myRasterLayer = new QgsRasterLayer(myFileNameQString, myBaseNameQString);
* \endcode
*
@@ -197,8 +196,6 @@ class CORE_EXPORT QgsRasterLayer : public QgsMapLayer
* -Determine whether the layer is gray, paletted or multiband.
*
* -Assign sensible defaults for the red, green, blue and gray bands.
*
* -
* */
explicit QgsRasterLayer( const QString &uri,
const QString &baseName = QString(),

0 comments on commit 2a72eda

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