From 41f6ce552a513644a90793a8bba15ef5761821cc Mon Sep 17 00:00:00 2001 From: Renato Araujo Oliveira Filho Date: Thu, 22 Nov 2012 17:58:56 -0300 Subject: Added docs on new functions. --- libqmenumodel/src/qstateaction.cpp | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) (limited to 'libqmenumodel/src') diff --git a/libqmenumodel/src/qstateaction.cpp b/libqmenumodel/src/qstateaction.cpp index 18c3c81..1861aea 100644 --- a/libqmenumodel/src/qstateaction.cpp +++ b/libqmenumodel/src/qstateaction.cpp @@ -88,21 +88,30 @@ bool QStateAction::isValid() const return m_valid; } -QString QStateAction::name() const -{ - return m_name; -} - +/*! + Request for the state of action to be changed to \a paramenter. + This call merely requests a change. The action may refuse to change its state or may change its state to something other than \a paramenter. +*/ void QStateAction::updateState(const QVariant ¶meter) { m_group->updateActionState(m_name, parameter); } +/*! + Activates the action passing \a parameter. + \a parameter must be the correct type of parameter for the action +*/ void QStateAction::activate(const QVariant ¶meter) { m_group->activateAction(m_name, parameter); } +/*! \internal */ +QString QStateAction::name() const +{ + return m_name; +} + /*! \internal */ void QStateAction::setValid(bool valid) { -- cgit v1.2.3