summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDaniel d'Andrada <daniel.dandrada@luxoft.com>2018-07-23 17:27:47 +0200
committerRobert Griebl <robert.griebl@pelagicore.com>2018-07-24 10:45:45 +0000
commitde885bc1fb89dbe7cddd7c5e8a1f2d19fb2f820c (patch)
treeefb269f6ad1958581ad28048e33ef668a4b773e1
parentc02029bb2db5e00fc89845892daacfd607485e33 (diff)
Update examples documentation due to recent changes
* since examples have been moved into an applicationmanager subdir, \quotefromfile paths have to reflect that * minidesk code changed in the meantime, so a \printto reference needed an update as well Change-Id: Idad8c7ac290a2562bb615011ec94faa56c8eee8f Reviewed-by: Robert Griebl <robert.griebl@pelagicore.com>
-rw-r--r--examples/applicationmanager/custom-appman/doc/src/custom-appman.qdoc4
-rw-r--r--examples/applicationmanager/minidesk/doc/src/minidesk.qdoc16
-rw-r--r--examples/applicationmanager/monitor/doc/src/monitor.qdoc6
3 files changed, 13 insertions, 13 deletions
diff --git a/examples/applicationmanager/custom-appman/doc/src/custom-appman.qdoc b/examples/applicationmanager/custom-appman/doc/src/custom-appman.qdoc
index 5ea6d44f..baa82cc2 100644
--- a/examples/applicationmanager/custom-appman/doc/src/custom-appman.qdoc
+++ b/examples/applicationmanager/custom-appman/doc/src/custom-appman.qdoc
@@ -27,7 +27,7 @@
/*!
-\example custom-appman
+\example applicationmanager/custom-appman
\title Implementing a Custom Application-Manager Example
\image custom-appman.png Screenshot
\brief Basic structure and starting point for a custom application-manager executable.
@@ -53,7 +53,7 @@ display something on the screen, just as the standard \c appman executable.
Following is a breakdown of the minimal code needed for such a custom implementation:
-\quotefromfile custom-appman/custom-appman.cpp
+\quotefromfile applicationmanager/custom-appman/custom-appman.cpp
\skipto #include
\printuntil QT_USE_NAMESPACE_AM
diff --git a/examples/applicationmanager/minidesk/doc/src/minidesk.qdoc b/examples/applicationmanager/minidesk/doc/src/minidesk.qdoc
index ad85c36e..b90753ce 100644
--- a/examples/applicationmanager/minidesk/doc/src/minidesk.qdoc
+++ b/examples/applicationmanager/minidesk/doc/src/minidesk.qdoc
@@ -27,7 +27,7 @@
/*!
-\example minidesk
+\example applicationmanager/minidesk
\title Desktop System-UI Example
\image minidesk.png Screenshot
\brief Minimal Desktop System-UI in pure QML
@@ -80,7 +80,7 @@ path/to/bin/appman -c am-config.yaml -r --start-session-dbus
\section2 System-UI Window
-\quotefromfile minidesk/system-ui/main.qml
+\quotefromfile applicationmanager/minidesk/system-ui/main.qml
\skipto import Qt
\printuntil text:
\printline }
@@ -115,7 +115,7 @@ two applications in an \l{ApplicationManagerWindow} root element.
\section2 Application Windows in the System-UI
-\printto System-UI for a pop-up and notification
+\printto System-UI for pop-ups
This second \l{Repeater} provides the window chrome for the actual applications in its delegate.
The model is the same as for the first \l{Repeater}, essentially the \l{ApplicationManager}
@@ -151,7 +151,7 @@ This is the corresponding System-UI code:
The \c popUpContainer \l{Item} provides a System-UI recipient for the pop-up rendered
by App1. App1 instantiates another \l{ApplicationManagerWindow} for the pop-up within its
\l{ApplicationManagerWindow} root element, as shown here:
-\quotefromfile minidesk/apps/tld.minidesk.app1/app1.qml
+\quotefromfile applicationmanager/minidesk/apps/tld.minidesk.app1/app1.qml
\skipto Rectangle
\skipto ApplicationManagerWindow
\printuntil Component.onCompleted
@@ -167,7 +167,7 @@ An alternative to the above approach is to use the application-manager's \l{Noti
the application (client) side and the \l{NotificationManager} API on the System-UI (server) side.
The following code is invoked when the \e bulb icon of App2 is clicked:
-\quotefromfile minidesk/apps/tld.minidesk.app2/app2.qml
+\quotefromfile applicationmanager/minidesk/apps/tld.minidesk.app2/app2.qml
\skipto var notification
\printuntil notification.show();
@@ -179,7 +179,7 @@ notification. Presenting the first notification only is a simplification to keep
\section2 WindowManager Signal Handler
-\quotefromfile minidesk/system-ui/main.qml
+\quotefromfile applicationmanager/minidesk/system-ui/main.qml
\skipto Handler for WindowManager signals
\printto IPC extension
This is the vital part of the System-UI, where the window surfaces of the applications are mapped
@@ -229,7 +229,7 @@ be used from the application processes.
On the application side, the \l{ApplicationInterfaceExtension} type has to be used. Here is how
App2 makes use of this interface extension:
-\quotefromfile minidesk/apps/tld.minidesk.app2/app2.qml
+\quotefromfile applicationmanager/minidesk/apps/tld.minidesk.app2/app2.qml
\skipto ApplicationInterfaceExtension
\printuntil onPiChanged
\printline }
@@ -245,7 +245,7 @@ When an application is stopped from the System-UI through
the \l{ApplicationInterface::quit()}{ApplicationInterface.quit()} signal. The application can do
some clean-up and must subsequently confirm with
\l{ApplicationInterface::acknowledgeQuit()}{ApplicationInterface.acknowledgeQuit()}, like App2 does:
-\quotefromfile minidesk/apps/tld.minidesk.app2/app2.qml
+\quotefromfile applicationmanager/minidesk/apps/tld.minidesk.app2/app2.qml
\skipto Connections
\printuntil onQuit
\printline }
diff --git a/examples/applicationmanager/monitor/doc/src/monitor.qdoc b/examples/applicationmanager/monitor/doc/src/monitor.qdoc
index 603f6b36..6de86d03 100644
--- a/examples/applicationmanager/monitor/doc/src/monitor.qdoc
+++ b/examples/applicationmanager/monitor/doc/src/monitor.qdoc
@@ -27,7 +27,7 @@
/*!
-\example monitor
+\example applicationmanager/monitor
\title Performance Monitoring Example
\image monitor.png Screenshot
\brief A resource and performance monitor
@@ -61,7 +61,7 @@ We will start from the bottom, because this is the essential part.
\section2 SystemMonitor and ProcessMonitor Usage
-\quotefromfile monitor/system-ui/main.qml
+\quotefromfile applicationmanager/monitor/system-ui/main.qml
\skipto ProcessMonitor
\printuntil ApplicationManager.startApplication
\printline }
@@ -92,7 +92,7 @@ ProcessMonitor::processId will be set to 0.
\section2 The User Interface
-\quotefromfile monitor/system-ui/main.qml
+\quotefromfile applicationmanager/monitor/system-ui/main.qml
\skipto import Qt
\printto ProcessMonitor
\dots