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.
This commit is contained in:
Chris Mayo 2018-08-23 20:17:43 +01:00 committed by Nyall Dawson
parent 51ec333199
commit 2a72eda514
2 changed files with 1 additions and 6 deletions

View File

@ -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();

View File

@ -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(),