API-Documentation: Add the Utils-library.

Fix API after doc template change.
This commit is contained in:
Friedemann Kleint
2011-03-02 17:13:33 +01:00
parent b37cd3325c
commit 505256fab9
63 changed files with 458 additions and 301 deletions

View File

@@ -33,6 +33,24 @@
#include "parameteraction.h"
/*!
\class Utils::ParameterAction
\brief Intended for actions that act on a 'current',
string-type parameter (typically a file name), for example 'Save file %1'.
The action has 2 states:
\list
\o <no current parameter> displaying "Do XX" (empty text)
\o <parameter present> displaying "Do XX with %1".
\endlist
Provides a slot to set the parameter, changing display
and enabled state accordingly.
The text passed in should already be translated; parameterText
should contain a %1 where the parameter is to be inserted.
*/
namespace Utils {
ParameterAction::ParameterAction(const QString &emptyText,