┌   ┐
54
└   ┘

summaryrefslogtreecommitdiff
path: root/src/selectionmode/actionwithwidget.h
diff options
context:
space:
mode:
authorFelix Ernst <[email protected]>2022-04-25 12:52:05 +0200
committerFelix Ernst <[email protected]>2022-08-14 14:42:40 +0000
commit78cffd2979a6ed87e044fcb024cf4fdfc5c7cb3d (patch)
tree7e5b66a5b4fc8c3328949d80898be2d1d57da5b7 /src/selectionmode/actionwithwidget.h
parent8e55f2c2409fd6ca9ebc66a6568f4d3bcbef7576 (diff)
Improve code quality
Diffstat (limited to 'src/selectionmode/actionwithwidget.h')
-rw-r--r--src/selectionmode/actionwithwidget.h13
1 files changed, 8 insertions, 5 deletions
diff --git a/src/selectionmode/actionwithwidget.h b/src/selectionmode/actionwithwidget.h
index cf7b8bc35..14db6df22 100644
--- a/src/selectionmode/actionwithwidget.h
+++ b/src/selectionmode/actionwithwidget.h
@@ -21,6 +21,9 @@ namespace SelectionMode
* @brief Small wrapper/helper class that contains an action and its widget.
*
* This class takes neither the responsibility for deleting its action() nor its widget().
+ *
+ * This class is only used from BottomBarContentsContainer currently.
+ * @see BottomBarContentsContainer
*/
class ActionWithWidget
{
@@ -28,9 +31,9 @@ public:
ActionWithWidget(QAction *action);
/**
- * Connect @p action and @p button using copyActionDataToButton() and the
- * wraps the two together in the ActionWithWidget object.
- * ActionWithWidget doesn't take any ownership.
+ * Connect @p action and @p button using copyActionDataToButton() and
+ * wraps the two together in a ActionWithWidget object.
+ * ActionWithWidget doesn't take any ownership over the parameters.
*
* @see copyActionDataToButton()
*
@@ -38,7 +41,7 @@ public:
*/
ActionWithWidget(QAction *action, QAbstractButton *button);
- /** @returns the action of this object. Crashes if that action has been deleted elsewhere in the meantime. */
+ /** @returns the action of this object. */
inline QAction *action() {
Q_CHECK_PTR(m_action);
return m_action;
@@ -69,7 +72,7 @@ private:
/**
* A small helper method.
- * @return a button with the correct styling for the general mode of the SelectionModeBottomBar which can be added to its layout.
+ * @return a button with the correct styling for the general mode of the BottomBarContentsContainer which can be added to its layout.
*/
QAbstractButton *newButtonForAction(QAction *action, QWidget *parent);