Skip to content

Commit 60df926

Browse files
committed
Add missing docs
1 parent 6f4b6a6 commit 60df926

File tree

4 files changed

+17
-0
lines changed

4 files changed

+17
-0
lines changed

src/gui/layertree/qgslayertreeembeddedconfigwidget.h

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,10 @@ class GUI_EXPORT QgsLayerTreeEmbeddedConfigWidget : public QWidget, protected Ui
2929
{
3030
Q_OBJECT
3131
public:
32+
/**
33+
* A widget to configure layer tree embedded widgets for a particular map layer.
34+
* @param parent The parent of the widget.
35+
*/
3236
QgsLayerTreeEmbeddedConfigWidget( QWidget* parent = nullptr );
3337

3438
//! Initialize widget with a map layer

src/gui/symbology-ng/qgsrendererv2widget.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,11 @@ class GUI_EXPORT QgsRendererV2Widget : public QWidget
8989
*/
9090
void widgetChanged();
9191

92+
/**
93+
* @brief Emitted when a sub panel for the widget is opened.
94+
* The renderer can open inline sub panels instead of dialogs.
95+
* @param opened
96+
*/
9297
void panelOpened( bool opened );
9398

9499
protected:

src/gui/symbology-ng/qgsrendererwidgetcontainer.h

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,10 @@ class GUI_EXPORT QgsRendererWidgetContainer : public QWidget, private Ui::QgsRen
5353
public slots:
5454

5555
protected:
56+
/**
57+
* @brief Overriden key press event to handle the esc event on the widget.
58+
* @param event The key event
59+
*/
5660
void keyPressEvent( QKeyEvent* event );
5761

5862
};

src/gui/symbology-ng/qgssymbolv2selectordialog.h

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,10 @@ class GUI_EXPORT QgsSymbolV2SelectorDialog : public QDialog, private Ui::QgsSymb
106106
*/
107107
void setMapCanvas( QgsMapCanvas* canvas );
108108

109+
/**
110+
* @brief Return the symbol that is currently active in the widget. Can be null.
111+
* @return The active symbol.
112+
*/
109113
QgsSymbolV2* symbol() { return mSymbol; }
110114

111115
protected:

0 commit comments

Comments
 (0)