Skip to content
Permalink
Browse files

Fix some documentation formatting

  • Loading branch information
DelazJ authored and nyalldawson committed Sep 6, 2018
1 parent f5bf15b commit 4ce10fccf0cc40659c233b4f91d109fcb14ab1ad
Showing with 20 additions and 23 deletions.
  1. +20 −23 src/gui/qgisinterface.h
@@ -181,7 +181,7 @@ class GUI_EXPORT QgisInterface : public QObject

/**
* Advanced digitizing dock widget
* \since QGIS 2.12
* \since QGIS 2.12
*/
virtual QgsAdvancedDigitizingDockWidget *cadDockWidget() = 0;

@@ -867,7 +867,7 @@ class GUI_EXPORT QgisInterface : public QObject
virtual bool openFeatureForm( QgsVectorLayer *l, QgsFeature &f, bool updateFeatureOnly = false, bool showModal = true ) = 0;

/**
* Returns a feature form for a given feature
* Returns a feature form for a given feature.
*
* \param l The layer for which the dialog will be created
* \param f The feature for which the dialog will be created
@@ -878,13 +878,13 @@ class GUI_EXPORT QgisInterface : public QObject

/**
* This method is only needed when using a UI form with a custom widget plugin and calling
* openFeatureForm or getFeatureForm from Python (PyQt4) and you haven't used the info tool first.
* openFeatureForm or getFeatureForm from Python (PyQt) and you haven't used the info tool first.
* Python will crash bringing QGIS with it
* if the custom form is not loaded from a C++ method call.
*
* This method uses a QTimer to call QUiLoader in order to load the form via C++
* you only need to call this once after that you can call openFeatureForm/getFeatureForm
* like normal
* This method uses a QTimer to call QUiLoader in order to load the form via C++.
* You only need to call this once. After that you can call openFeatureForm/getFeatureForm
* like usual.
*
* More information here: http://qt-project.org/forums/viewthread/27098/
*/
@@ -933,7 +933,7 @@ class GUI_EXPORT QgisInterface : public QObject

/**
* Emitted whenever current (selected) layer changes.
* The pointer to layer can be null if no layer is selected
* The pointer to layer can be null if no layer is selected.
*/
void currentLayerChanged( QgsMapLayer *layer );

@@ -969,34 +969,31 @@ class GUI_EXPORT QgisInterface : public QObject
void layoutDesignerClosed();

/**
* This signal is emitted when the initialization is complete
* This signal is emitted when the initialization is complete.
*/
void initializationCompleted();

/**
* Emitted when a project file is successfully read
* \note
* This is useful for plug-ins that store properties with project files. A
* plug-in can connect to this signal. When it is emitted, the plug-in
* knows to then check the project properties for any relevant state.
* Emitted when a project file is successfully read.
* \note This is useful for plugins that store properties with project files.
* A plugin can connect to this signal. When it is emitted, the plugin
* knows to then check the project properties for any relevant state.
*/
void projectRead();

/**
* Emitted when starting an entirely new project
* \note
* This is similar to projectRead(); plug-ins might want to be notified
* that they're in a new project. Yes, projectRead() could have been
* overloaded to be used in the case of new projects instead. However,
* it's probably more semantically correct to have an entirely separate
* signal for when this happens.
* Emitted when starting an entirely new project.
* \note This is similar to projectRead(); plugins might want to be notified
* that they're in a new project. Yes, projectRead() could have been
* overloaded to be used in the case of new projects instead. However,
* it's probably more semantically correct to have an entirely separate
* signal for when this happens.
*/
void newProjectCreated();

/**
* This signal is emitted when a layer has been saved using save as
* \note
* added in version 2.7
* This signal is emitted when a layer has been saved using save as.
* \since QGIS 2.7
*/
void layerSavedAs( QgsMapLayer *l, const QString &path );

0 comments on commit 4ce10fc

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