Documentation

[situare] / src / ui / panelbase.h

diff --git a/src/ui/panelbase.h b/src/ui/panelbase.h
index 6812113..dee16ab 100644 (file)
--- a/src/ui/panelbase.h
+++ b/src/ui/panelbase.h
@@ -60,9 +60,19 @@ public:
      */
     QWidget* genericPanelButtons() const;
 
+    /**
+     * @brief Getter for the list item related context buttons
+     *
+     * @returns Pointer to context buttons widget
+     */
     QWidget* itemButtons() const;
 
 protected slots:
+    /**
+     * @brief Call when there is a change in list item selection
+     *
+     * Emits listItemSelectionChanged(bool). Parameter is true if any item is selected.
+     */
     void onListItemSelectionChanged();
 
 /*******************************************************************************
@@ -76,6 +86,11 @@ signals:
      */
     void openPanelRequested(QWidget *widget);
 
+    /**
+     * @brief Emitted when there is a change in list item selection
+     *
+     * @param itemIsSelected True if any item is selected.
+     */
     void listItemSelectionChanged(bool itemIsSelected);
 
 /*******************************************************************************