API dox: fix doxygen notation with some post-position comments

This commit is contained in:
Friedrich W. H. Kossebau 2017-05-26 19:54:11 +02:00
parent 32e67a591e
commit 8749591922
2 changed files with 15 additions and 15 deletions

View File

@ -57,7 +57,7 @@ public:
ImmutableConstraint = 8, /**< the immutability (locked) nature of the applet changed */ ImmutableConstraint = 8, /**< the immutability (locked) nature of the applet changed */
StartupCompletedConstraint = 16, /**< application startup has completed */ StartupCompletedConstraint = 16, /**< application startup has completed */
ContextConstraint = 32, /**< the context (e.g. activity) has changed */ ContextConstraint = 32, /**< the context (e.g. activity) has changed */
UiReadyConstraint = 64, /** The ui has been completely loaded (FIXME: merged with StartupCompletedConstraint?) */ UiReadyConstraint = 64, /**< The ui has been completely loaded */ // (FIXME: merged with StartupCompletedConstraint?)
AllConstraints = FormFactorConstraint | LocationConstraint | ScreenConstraint | AllConstraints = FormFactorConstraint | LocationConstraint | ScreenConstraint |
ImmutableConstraint ImmutableConstraint
}; };
@ -109,12 +109,12 @@ public:
* A descriptrive type for QActions, to help categorizing them when presented to the user * A descriptrive type for QActions, to help categorizing them when presented to the user
*/ */
enum ActionType { enum ActionType {
AddAction = 0, /**The action will cause something new being created*/ AddAction = 0, /**< The action will cause something new being created*/
ConfigureAction = 100, /** The Action will make some kind of configuration ui to appear */ ConfigureAction = 100, /**< The Action will make some kind of configuration ui to appear */
ControlAction = 200, /** Generic control, similar to ConfigureAction TODO: better doc */ ControlAction = 200, /**< Generic control, similar to ConfigureAction TODO: better doc */
MiscAction = 300, /** A type of action that doesn't fit in the oher categories */ MiscAction = 300, /**< A type of action that doesn't fit in the oher categories */
DestructiveAction = 400, /** A dangerous action, such as deletion of objects, plasmoids and files. They are intended to be shown separed from other actions */ DestructiveAction = 400, /**< A dangerous action, such as deletion of objects, plasmoids and files. They are intended to be shown separed from other actions */
UserAction = DestructiveAction + 1000 /** If new types are needed in a C++ implementation, define them as ids more than UserAction*/ UserAction = DestructiveAction + 1000 /**< If new types are needed in a C++ implementation, define them as ids more than UserAction*/
}; };
Q_ENUM(ActionType) Q_ENUM(ActionType)

View File

@ -71,14 +71,14 @@ public:
BackgroundColor = 1, /**< the default background color */ BackgroundColor = 1, /**< the default background color */
HighlightColor = 2, /**< the text highlight color to be used by items resting HighlightColor = 2, /**< the text highlight color to be used by items resting
on the background */ on the background */
HoverColor = 3, /** color for hover effect on view */ HoverColor = 3, /**< color for hover effect on view */
FocusColor = 4, /** color for focus effect on view */ FocusColor = 4, /**< color for focus effect on view */
LinkColor = 5, /** color for clickable links */ LinkColor = 5, /**< color for clickable links */
VisitedLinkColor = 6, /** color visited clickable links */ VisitedLinkColor = 6, /**< color visited clickable links */
HighlightedTextColor = 7,/** color contrasting with HighlightColor, to be used for instance with */ HighlightedTextColor = 7,/**< color contrasting with HighlightColor, to be used for instance with */
PositiveTextColor = 8, /** color of foreground objects with a "positive message" connotation (usually green) */ PositiveTextColor = 8, /**< color of foreground objects with a "positive message" connotation (usually green) */
NeutralTextColor = 9, /** color of foreground objects with a "neutral message" connotation (usually yellow) */ NeutralTextColor = 9, /**< color of foreground objects with a "neutral message" connotation (usually yellow) */
NegativeTextColor = 10 /** color of foreground objects with a "negative message" connotation (usually red) */ NegativeTextColor = 10 /**< color of foreground objects with a "negative message" connotation (usually red) */
}; };
enum ColorGroup { enum ColorGroup {