From 377f7096eda99e9080e44e886405e512a98532a8 Mon Sep 17 00:00:00 2001 From: Olli Leppanen Date: Thu, 12 May 2011 15:48:32 +0300 Subject: [PATCH] Changes: Corrected page grouping in doxygen RevBy: Pertti Kellomaki --- debian/changelog | 4 +++- doc/debianpackaging.dox | 2 +- doc/doxygen-userdoc.conf | 5 +++-- doc/eboost.dox | 4 ++-- doc/libmeegotouchboost.dox | 10 ++++----- doc/mainpage.dox | 45 +++++++++++++------------------------- doc/qmlboost.dox | 10 ++++----- doc/qtboost.dox | 10 ++++----- doc/singleinstance.dox | 2 +- doc/splash.dox | 2 +- doc/tipsandtricks.dox | 26 ++++++++++++++++++++++ 11 files changed, 67 insertions(+), 53 deletions(-) create mode 100644 doc/tipsandtricks.dox diff --git a/debian/changelog b/debian/changelog index bb9da4f..e7d790f 100644 --- a/debian/changelog +++ b/debian/changelog @@ -1,8 +1,10 @@ applauncherd (0.29.6) unstable; urgency=low + * Changes: Corrected doxygen grouping in documentation * Changes: Added a command to run cpu in full speed to perf tests * Fixes: NB#254878 - COREWEB: /usr/bin/camera-ui.launch 'AppData::deleteArgv Booster::launchProcess' - + * Implemented: SWP#DUI-5313, SWP#DUI-5315 + -- Nimika Keshri Thu, 12 May 2011 11:34:15 +0300 applauncherd (0.29.5) stable; urgency=low diff --git a/doc/debianpackaging.dox b/doc/debianpackaging.dox index 6a0afbb..b825036 100644 --- a/doc/debianpackaging.dox +++ b/doc/debianpackaging.dox @@ -8,6 +8,6 @@ applauncherd-dev package, and applications that use the MeeGo Touch booster should build-depend on the \c libmeegotouch-dev package. When packaging applications for Harmattan, it may also be necessary to -\subpage aegis "modify the Aegis manifest" of the application. +\ref aegis "modify the Aegis manifest" of the application. */ diff --git a/doc/doxygen-userdoc.conf b/doc/doxygen-userdoc.conf index 639627c..89dfd6e 100644 --- a/doc/doxygen-userdoc.conf +++ b/doc/doxygen-userdoc.conf @@ -581,7 +581,8 @@ INPUT = mainpage.dox \ dbus.dox \ advancedapplauncherd.dox \ debianpackaging.dox \ - ../src/qdeclarativebooster/mdeclarativecache.h + tipsandtricks.dox \ + ../src/qdeclarativebooster/mdeclarativecache.h # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is @@ -968,7 +969,7 @@ ENUM_VALUES_PER_LINE = 4 # releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE # respectively. -GENERATE_TREEVIEW = NONE +GENERATE_TREEVIEW = YES # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be # used to set the initial width (in pixels) of the frame in which the tree diff --git a/doc/eboost.dox b/doc/eboost.dox index 438eaee..07a478e 100644 --- a/doc/eboost.dox +++ b/doc/eboost.dox @@ -10,11 +10,11 @@ even if the application is not a library. Applauncherd supports showing of a splash screen for applications. All those applications which can be boosted using the other boosters can show -splash screen as described \subpage splash "here". For those applications +splash screen as described \ref splash "here". For those applications which cannot be boosted and require to have a splash screen can use the Exec Booster. Hence for launching a splash screen for any application the Exec Booster can be used. Also the non boosted applications can be launched as a -\subpage singleinstance "Single Instance" application using the Exec Booster. +\ref singleinstance "Single Instance" application using the Exec Booster. \section runebooster Running application using Exec Booster diff --git a/doc/libmeegotouchboost.dox b/doc/libmeegotouchboost.dox index 0569ca0..e298b7e 100644 --- a/doc/libmeegotouchboost.dox +++ b/doc/libmeegotouchboost.dox @@ -50,8 +50,8 @@ a Debian package, make your package build-depend on \c libmeegotouch-dev. For details on how to get the compiler and linker flags, see -\subpage usingqmake "Using QMake", \subpage usingcmake "Using CMake", or -\subpage usingpkgconfig "Using pkg-config". +\ref usingqmake "Using QMake", \ref usingcmake "Using CMake", or +\ref usingpkgconfig "Using pkg-config". \section mtboostcache 2. Utilizing the booster cache' @@ -91,7 +91,7 @@ the application. However, if the application has explicit calls to \c exit(), these should be changed to use \c _exit() instead. The brief explanation is that this prevents cleanup actions related to shared libraries to be performed multiple times. For more details see -\subpage limitations "Limitations and known issues". +\ref limitations "Limitations and known issues". \section mtboostinvoker 4. Launching the application @@ -132,8 +132,8 @@ invoker --type=m /usr/bin/myApp The invoker can also provide single instance behavior and a splash screen for you application as follows. For more details, see -\subpage singleinstance "the single instance documentation" and -\subpage splash "the splash screen documentation." +\ref singleinstance "the single instance documentation" and +\ref splash "the splash screen documentation." \code /usr/bin/invoker --single-instance --splash=/usr/share/myApp/splash.jpg --type=m /usr/bin/myApp diff --git a/doc/mainpage.dox b/doc/mainpage.dox index e07fa3f..959f8eb 100644 --- a/doc/mainpage.dox +++ b/doc/mainpage.dox @@ -1,6 +1,6 @@ /*! \mainpage Optimizing Application Startup -\section intro Introduction +\section introduction Introduction The \c invoker program and the \c applauncherd daemon help applications launch faster and save memory via shared resources and @@ -64,8 +64,8 @@ The \c invoker can be used to get a splash screen for the application and to implement single instance behavior. If the \a exec \a booster is used, no modifications to the application source code are needed. Simply specify the name of the splash image on the invoker command line as -follows. For more details see \subpage eboost "the exec booster documentation" and -\subpage splash "the splash documentation". +follows. For more details see \ref eboost "the exec booster documentation" and +\ref splash "the splash documentation". \code invoker --type=e --splash=/usr/share/images/myAppSplash.jpg /usr/bin/myApp @@ -82,7 +82,7 @@ This causes \c invoker to look for a running instance of the application using a simple lock file based mechanism. If an already running instance is found, it is brought to the foreground instead of launching a new instance of the application. See -\subpage singleinstance "the single instance documentation" for more +\ref singleinstance "the single instance documentation" for more information. The options can also be combined, in which case the splash screen is @@ -135,44 +135,29 @@ invoker --type=d ./qml-helloworld \endcode Normally the compiler and linker flags would be provided automatically -either by using \subpage usingpkgconfig "pkg-config" directly, or using it -via \subpage usingcmake "cmake" or \subpage usingqmake "qmake". +either by using \ref usingpkgconfig "pkg-config" directly, or using it +via \ref usingcmake "cmake" or \ref usingqmake "qmake". It is also a good idea to hide any unnecessary symbols in the application binary to speed up opening it in the booster. How to do -this is covered in \subpage qmlboost "the QML booster documentation" -and \subpage libmeegotouchboost "the MeeGo Touch booster documentation". +this is covered in \ref qmlboost "the QML booster documentation" +and \ref libmeegotouchboost "the MeeGo Touch booster documentation". \section reference Reference documentation - How to enable boosted startup for different types of applications: - - \ref qmlboost "QML" - - \ref qtboost "Qt" - - \ref libmeegotouchboost "MeeGo Touch" - - \ref eboost "Generic booster for all applications" + - \subpage qmlboost "QML" + - \subpage qtboost "Qt" + - \subpage libmeegotouchboost "MeeGo Touch" + - \subpage eboost "Generic booster for all applications" -- \ref splash "How to enable splash screen for the application" +- \subpage splash "How to enable splash screen for the application" -- \ref singleinstance "How to enable single instance support for the application" - -- \ref invokerparameters "Advanced \c invoker command line parameters" - -- \ref advancedapplauncherd "Advanced \c applauncherd usage" +- \subpage singleinstance "How to enable single instance support for the application" \section tipsntricks Tips and tricks -- How to compile and link applications with different build systems: - - \ref usingcmake "CMake" - - \ref usingqmake "QMake" - - \ref usingpkgconfig "pkg-config" - -- \ref debug "How to debug boosted applications" - -- \ref dbus "How to use applauncherd with D-Bus" - -- \ref aegis "Aegis platform security and applauncherd" - -- \ref limitations "Limitations and known issues" +See separate page for \subpage tipsandtricks */ diff --git a/doc/qmlboost.dox b/doc/qmlboost.dox index 7f19fab..adc4a4f 100644 --- a/doc/qmlboost.dox +++ b/doc/qmlboost.dox @@ -45,8 +45,8 @@ a Debian package, make your package build-depend on \c applauncherd-dev. For details on how to get the compiler and linker flags, see -\subpage usingqmake "Using QMake", \subpage usingcmake "Using CMake", or -\subpage usingpkgconfig "Using pkg-config". +\ref usingqmake "Using QMake", \ref usingcmake "Using CMake", or +\ref usingpkgconfig "Using pkg-config". \section qmlboostcache 2. Utilizing the booster cache @@ -90,7 +90,7 @@ the application. However, if the application has explicit calls to \c exit(), these should be changed to use \c _exit() instead. The brief explanation is that this prevents cleanup actions related to shared libraries to be performed multiple times. For more details see -\subpage limitations "Limitations and known issues". +\ref limitations "Limitations and known issues". \section qmlboostinvoker 4. Launching the application @@ -136,8 +136,8 @@ application to use the invoker command. The invoker can also provide single instance behavior and a splash screen for you application as follows. For more details, see -\subpage singleinstance "the single instance documentation" and -\subpage splash "the splash screen documentation." +\ref singleinstance "the single instance documentation" and +\ref splash "the splash screen documentation." \code /usr/bin/invoker --single-instance --splash=/usr/share/myApp/splash.jpg --type=d /usr/bin/myApp diff --git a/doc/qtboost.dox b/doc/qtboost.dox index 9a0a883..4a64fde 100644 --- a/doc/qtboost.dox +++ b/doc/qtboost.dox @@ -45,8 +45,8 @@ a Debian package, make your package build-depend on \c applauncherd-dev. For details on how to get the compiler and linker flags, see -\subpage usingqmake "Using QMake", \subpage usingcmake "Using CMake", or -\subpage usingpkgconfig "Using pkg-config". +\ref usingqmake "Using QMake", \ref usingcmake "Using CMake", or +\ref usingpkgconfig "Using pkg-config". \section qtboostexit 2. Adapting application source code @@ -55,7 +55,7 @@ used. However, if the application has explicit calls to \c exit(), these should be changed to use \c _exit() instead. The brief explanation is that this prevents cleanup actions related to shared libraries to be performed multiple times. For more details see -\subpage limitations "Limitations and known issues". +\ref limitations "Limitations and known issues". \section qtboostinvoker 3. Launching the application @@ -72,8 +72,8 @@ invoker --type=q /usr/bin/myApp The invoker can also provide single instance behavior and a splash screen for you application as follows. For more details, see -\subpage singleinstance "the single instance documentation" and -\subpage splash "the splash screen documentation." +\ref singleinstance "the single instance documentation" and +\ref splash "the splash screen documentation." \code /usr/bin/invoker --single-instance --splash=/usr/share/myApp/splash.jpg --type=q /usr/bin/myApp diff --git a/doc/singleinstance.dox b/doc/singleinstance.dox index 33d44be..710a20f 100644 --- a/doc/singleinstance.dox +++ b/doc/singleinstance.dox @@ -1,4 +1,4 @@ -/*! \page singleinstance How to enable single instance support for the application +/*! \page singleinstance How To Enable Single Instance Support For the Application Usually user wants his application to be run as a single instance. This means, that if the launched application is already running, the existing application diff --git a/doc/splash.dox b/doc/splash.dox index 34fc36a..7ce6931 100644 --- a/doc/splash.dox +++ b/doc/splash.dox @@ -1,4 +1,4 @@ -/*! \page splash How To Enable Splash Screen For The Application +/*! \page splash How To Enable Splash Screen For the Application \section splashsec Enabling splash screen diff --git a/doc/tipsandtricks.dox b/doc/tipsandtricks.dox new file mode 100644 index 0000000..32e366f --- /dev/null +++ b/doc/tipsandtricks.dox @@ -0,0 +1,26 @@ +/*! \page tipsandtricks Tips and tricks + +This page contains miscellaneous tips and triks for using \c invoker and \c applauncherd + +- \subpage invokerparameters "Advanced \c invoker command line parameters" + +- \subpage advancedapplauncherd "Advanced \c applauncherd usage" + +- How to compile and link applications with different build systems: + - \subpage usingcmake "CMake" + - \subpage usingqmake "QMake" + - \subpage usingpkgconfig "pkg-config" + +- \subpage debug "How to debug boosted applications" + +- \subpage dbus "How to use applauncherd with D-Bus" + +- \subpage aegis "Aegis platform security and applauncherd" + +- \subpage limitations "Limitations and known issues" + +- \subpage debianpackaging "Debian packaging" + +*/ + +