API dox: use @code/@endcode

GIT_SILENT
This commit is contained in:
Friedrich W. H. Kossebau 2019-09-08 23:33:09 +02:00
parent 5f746ce1c2
commit 5e09728c1b
3 changed files with 6 additions and 6 deletions

View File

@ -45,12 +45,12 @@ class SvgItem : public QQuickItem
/** /**
* Svg class that is the source of the image, use it like that: * Svg class that is the source of the image, use it like that:
* <code> * @code
* SvgItem { * SvgItem {
* svg: Svg {imagePath: "widgets/arrows"} * svg: Svg {imagePath: "widgets/arrows"}
* elementId: "arrow-left" * elementId: "arrow-left"
* } * }
* </code> * @endcode
* Instead of a Svg declaration it can also be the id of a Svg declared elsewhere, useful to share Svg instances. * Instead of a Svg declaration it can also be the id of a Svg declared elsewhere, useful to share Svg instances.
*/ */
Q_PROPERTY(Plasma::Svg *svg READ svg WRITE setSvg NOTIFY svgChanged) Q_PROPERTY(Plasma::Svg *svg READ svg WRITE setSvg NOTIFY svgChanged)

View File

@ -29,12 +29,12 @@
* Class which handles an application execution. * Class which handles an application execution.
* *
* Example: * Example:
* <code> * @code
* Application { * Application {
* application: "xterm" * application: "xterm"
* running: terminalRunningCheckbox.checked * running: terminalRunningCheckbox.checked
* } * }
* </code> * @endcode
*/ */
class Application: public QObject class Application: public QObject
{ {

View File

@ -31,7 +31,7 @@
* @deprecated Use IconDialog from org.kde.kquickcontrolsaddons * @deprecated Use IconDialog from org.kde.kquickcontrolsaddons
* *
* Example: * Example:
* <code> * @code
* IconDialog { * IconDialog {
* id: iconDialog * id: iconDialog
* } * }
@ -39,7 +39,7 @@
* ... * ...
* *
* icon = iconDialog.openDialog() * icon = iconDialog.openDialog()
* </code> * @endcode
*/ */
class IconDialog: public QObject class IconDialog: public QObject
{ {