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.
qgis · Aug 23, 2018 · 2a72eda · 2a72eda
1 parent 51ec333
commit 2a72eda
Show file tree

Hide file tree

Showing 2 changed files with 1 addition and 6 deletions.
diff --git a/python/core/auto_generated/raster/qgsrasterlayer.sip.in b/python/core/auto_generated/raster/qgsrasterlayer.sip.in
@@ -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();

diff --git a/src/core/raster/qgsrasterlayer.h b/src/core/raster/qgsrasterlayer.h
@@ -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(),