Fixes: NB#183185 - Broken links in public API doc

RevBy: Tomas Junnonen

Details:
I fixed the broken links by using \subpage and \ref instead
of html markup. Additionally I fixed some doxygen warnings.

5 files changed, 32 insertions, 32 deletions

diff --git a/doc/src/faststartup.dox b/doc/src/faststartup.dox
index dba2389e..a8e65a14 100644
--- a/doc/src/faststartup.dox
+++ b/doc/src/faststartup.dox
@@ -3,7 +3,7 @@
 There are three features that enable improving MApplication startup
 times:
 
-\li The <a href="launcher.html">application launcher</a> is the
+\li The \subpage launcher "application launcher" is the
 primary alternative for shortening application startup times. It will
 preload large libraries and instantiate e.g. MApplication and
 MApplicationWindow objects to so called component cache before the
@@ -12,7 +12,7 @@ the already created instances from the component cache. However, there
 are some limitations to launcher usage. For instance it does not
 support some MeeGoTouch and Qt command line options.
 
-\li <a href="prestart.html">Application prestarting</a> is meant for
+\li \subpage prestart "Application prestarting" is meant for
 applications that cannot avoid slow initializations before they can be
 used. Prestarting enables starting up those applications to a state
 where they do not show UI. From that state they can show a window in
@@ -24,7 +24,7 @@ prestarting is limited to a small set of critical applications. This
 feature cannot be used without support from the system
 configuration.</strong>
 
-\li <a href="prestart.html">Lazy shutdown</a> allows applications to
+\li \ref prestart "Lazy shutdown" allows applications to
 be closed without terminating. This allows an application to show its
 window very quickly when it is needed next time. Lazy shutdown does
 not speed up the first startup at all, but it improves the performance
@@ -34,8 +34,8 @@ An application can use any combination of the above features.
 
 \section links Documentation links 
 
-    \li <a href="launcher.html">How to write launchable applications</a>
+    \li \ref launcher "How to write launchable applications"
 
-    \li <a href="prestart.html">How to write prestartable and lazy shutdownable applications</a>
+    \li \ref prestart "How to write prestartable and lazy shutdownable applications"
 
 */
diff --git a/doc/src/styling.dox b/doc/src/styling.dox
index 5e58be65..3cca2a9e 100644
--- a/doc/src/styling.dox
+++ b/doc/src/styling.dox
@@ -29,10 +29,10 @@ DirectUI provides a powerful styling engine for applications to customize their
           to the requirements.
 
 \section links Documentation links 
-    \li <a href="styling__concepts.html">Basic concepts of styling</a>
-    \li <a href="styling__features.html">Features</a>
-    \li <a href="styling__support.html">Styling support for applications & external libraries</a>
-    \li <a href="styling__stylesheets.html">Stylesheet syntax reference & examples</a>
-    \li <a href="styling__in__code.html">Architecture & code examples</a>
+    \li \subpage styling_concepts "Basic concepts of styling"
+    \li \subpage styling_features "Features"
+    \li \subpage styling_support "Styling support for applications & external libraries"
+    \li \subpage styling_stylesheets "Stylesheet syntax reference & examples"
+    \li \subpage styling_in_code "Architecture & code examples"
 
 */
diff --git a/doc/src/styling_stylesheets.dox b/doc/src/styling_stylesheets.dox
index c8ed9123..ba043199 100644
--- a/doc/src/styling_stylesheets.dox
+++ b/doc/src/styling_stylesheets.dox
@@ -13,8 +13,8 @@
     for the styleheet definition from top to bottom. Most of the syntax follows the basic CSS rules but there 
     are also some DirectUI -specific additions.
 
-        \subsection import Import
-            Syntax: @import ""; or @import url("");
+        \subsection import_sheet Import
+            Syntax: \@import ""; or \@import url("");
 
             Description: Makes it possible to import other stylesheet files and in this way combine multiple 
             stylesheets as one.
@@ -35,7 +35,7 @@
         \subsection selectors Selectors
             Syntax: styleclassname { }
 
-            Full syntax: styleclassname[type]#name.orientation:mode (all the parameters are optional but their order 
+            Full syntax: styleclassname[type]\#name.orientation:mode (all the parameters are optional but their order
             needs to be correct)
 
             Description: Groups attributes for a defined style
@@ -54,7 +54,7 @@
             {
                 // my own font definition and text color
                 my-font: "sans" 15;
-                my-text-color: #FFFFFF;
+                my-text-color: \#FFFFFF;
             }
 
             // these attributes won't inherit to subclasses because of the dot in the front of the styleclassname
@@ -96,7 +96,7 @@
             <tr><th>Datatype</th> <th>Syntax</th> <th>Example</th></tr>
             <tr><td>bool</td> <td>true, false</td> <td>visible: false;</td></tr>
             <tr><td>int</td> <td>numeric value</td> <td>age: 42;</td></tr>
-            <tr><td>QColor</td> <td>Color name. See QColor::setNamedColor for possible parameters</td> <td>color: #ffffff;</td></tr>
+            <tr><td>QColor</td> <td>Color name. See QColor::setNamedColor for possible parameters</td> <td>color: \#ffffff;</td></tr>
             <tr><td>qreal</td> <td>decimal value</td> <td>distance: 31.5;</td></tr>
             <tr><td>const QPixmap*</td> <td>image-id [width height]</td> <td>background: image_id;<br>background: image_id 128 128;</td></tr>
             <tr><td>const DuiScalableImage*</td> <td>image-id [left right top bottom]</td> <td>background: image_id;<br>background: image_id 0 128 0 128;</td></tr>
@@ -127,7 +127,7 @@
             </table>
 
         \subsection constants Constants
-            Syntax: @const constant-name: constant-value;
+            Syntax: \@const constant-name: constant-value;
 
             Description: Makes it possible define constant values in stylesheet, avoiding need to maintain 
             duplicated data that is spread around the stylesheet.
diff --git a/doc/src/styling_support.dox b/doc/src/styling_support.dox
index 008cb3bd..6d371b43 100644
--- a/doc/src/styling_support.dox
+++ b/doc/src/styling_support.dox
@@ -72,14 +72,14 @@
     \endcode
 
 
-    \sa <a href="theme_structure.html">Where to install the library spesific theme files</a>
+    \sa \ref theme_structure "Where to install the library spesific theme files"
 
 \section application_theme_support Theming support for applications
     Theming support for application works in a similar way that it works for external libraries with one big exception. The library is only able to
     configure the widgets it declares, but the application can override pretty much anything when it comes to theming & styling. Application can provide 
     it's own stylesheet & view configuration files, it can also register it's own widgets, views & styles to the system and provide theming for them. 
     It has pretty much full control for it's own look & feel. 
-    \sa <a href="theme_structure.html">Where to install the application specific theme files</a>.
+    \sa \ref theme_structure "Where to install the application specific theme files."
 
     \note As a library or application developer, you should always provide basic theming for your widgets in fallback theme.
 */
diff --git a/doc/src/theme_structure.dox b/doc/src/theme_structure.dox
index ad3d740e..467fcae2 100644
--- a/doc/src/theme_structure.dox
+++ b/doc/src/theme_structure.dox
@@ -60,7 +60,7 @@ This file contains constant definitions for this theme. The constant set is pred
 Constants are used in application code (DuiPalette, DuiDefaultFonts), and in stylesheets.
 
 When creating a new theme, this file is the one to start with. Just create an empty constants.ini and add a few lines from base:constants.ini
-with modified values. Now your theme contains <a href="#theme_description">index.theme</a>, and constants.ini; and is already a functional theme to be tried out!
+with modified values. Now your theme contains \ref theme_description "index.theme", and constants.ini; and is already a functional theme to be tried out!
 This is enough because DirectUI themes can inherit other themes. There is no need to copy some existing theme and
 start modifying it, instead it's recommended to inherit some theme and just change the parts you want.
 Here's a peek to one of the stylesheets in base-theme.
@@ -92,7 +92,7 @@ Rest of the values for constants.ini will come from the theme from which you inh
 \subsection theme_graphics Theme Graphics Directories
 
 There are three directories under each theme; images, svg and icons. These directories contains all common graphics for the theme.
-So if you're not pleased with your theme by just changing <a href="#theme_constants">constants.ini</a> you can always start doing some replacement
+So if you're not pleased with your theme by just changing \ref theme_constants "constants.ini" you can always start doing some replacement
 graphics.
 
 ImageId is a unique name for a piece of graphic. This imageId can be used from application code and from stylesheets and is also a reason, why
@@ -125,8 +125,8 @@ duibutton-background and create your graphics there.
 \subsection library Library Directory
 
 Every library which provides some new components(widgets) has to also provide default styling attributes for those. Developers of the library will place the default
-attribute values to <a href="#library_style">/usr/share/themes/base/dui/&lt;libraryname&gt;/style/</a>. Also if the library providing these components has made it possible to change
-the view part of the component, the developers of the library has placed the initial view configuration to <a href="#library_conf">/usr/share/themes/base/dui/&lt;libraryname&gt;/&lt;libraryname&gt;.conf</a>.
+attribute values to \ref library_style "/usr/share/themes/base/dui/&lt;libraryname&gt;/style/". Also if the library providing these components has made it possible to change
+the view part of the component, the developers of the library has placed the initial view configuration to \ref library_conf "/usr/share/themes/base/dui/&lt;libraryname&gt;/&lt;libraryname&gt;.conf".
 
 There is one directory for each library to be themed. Normally it's not necessary to create these library theming folders to your theme. In case you anyway need to
 change attibutes in stylesheets or you need to change the view part of a component, you must create a directory which has the same name as the library providing the
@@ -135,13 +135,13 @@ component (for example libnicewidgets-extras/).
 \subsection library_style Library Stylesheet Directory
 
 This directory can contain any number of stylesheet files. The recomendation is that every component(widget) in the library which can be styled would have it's own css-file.
-This directory must contain one css file which is the <a href="#library_css">entry point</a>. More of the stylesheets can be found from <a href="styling_stylesheets.html">Stylesheets</a>.
+This directory must contain one css file which is the \ref library_css "entry point". More of the stylesheets can be found from \ref styling_stylesheets "Stylesheets".
 
 \subsection library_css Library Main Stylesheet File
 
-This file is located to <a href="#library_style">style/</a> directory, and it's name must follow the name of the library (for example libnicewidgets-extras.css).
-This file will be the one which the system will read when reading style attributes for a class coming from this library. All other files in <a href="#library_style">style/</a>
-should be <a href="styling_stylesheets.html#import">@imported</a> from this file so they will also get read.
+This file is located to \ref library_style "style" directory, and it's name must follow the name of the library (for example libnicewidgets-extras.css).
+This file will be the one which the system will read when reading style attributes for a class coming from this library. All other files in \ref library_style "style"
+should be \ref import_sheet "@imported" from this file so they will also get read.
 
 \subsection library_conf Library View Configuration File
 
@@ -153,22 +153,22 @@ TODO: view libraries + link to view-config explanation
 
 All applications can provide additional styling for themselves, the application directory must have the same name as the application to be styled (for example widgetsgallery/).
 
-This directory can contain <a href="#application_graphics">graphics</a>, <a href="#application_style">stylesheets</a> and <a href="#application_conf">view configuration</a> for the application.
+This directory can contain \ref application_graphics "graphics", \ref application_style "stylesheets" and \ref application_conf "view configuration" for the application.
 
 \subsection application_graphcis Application Graphics Directories
 
 Usually when creating a theme you don't have to override the base-theme definitions for applications (most of the applications probably doesn't even have any special styling).
 Anyway if you want some specific application to look different than the theme specifies, you can do it by creating application-specific styling.
-Applications can override themes default graphics by inserting files to images/, svg/ or icons/ directories. The graphics overriding works the same way as it works with theme inheritance, so see <a href="#theme_graphics">Theme Graphics</a> for more info.
+Applications can override themes default graphics by inserting files to images/, svg/ or icons/ directories. The graphics overriding works the same way as it works with theme inheritance, so see \ref theme_graphics "Theme Graphics" for more info.
 
 \subsection application_style Application Stylesheet Directory
 
-Applications can override themes default stylesheet attribute values by creating a application stylesheet <a href="#application_css">entry point</a>.
+Applications can override themes default stylesheet attribute values by creating a application stylesheet \ref application_css "entry point".
 Applications can override any attributes from any component. Everything that is not overridden will still come from theme, so the recommendation is that applications override as few attributes as possible.
 
 \subsection application_css Application Main Stylesheet File
 
-This file is located to <a href="#application_style">style/</a> directory, and the name of the file has to be the same which the application has.
+This file is located to \ref application_style "style" directory, and the name of the file has to be the same which the application has.
 
 \subsection application_conf Application View Configuration File
 
@@ -198,7 +198,7 @@ This directory contains directories for different locales. All locales needing s
 
 \subsection locale_l Locale Specific Directory
 
-This directory is located to /usr/share/themes/<theme>/dui/locale/<locale>/ where the <locale> is fi, en, etc. Definitions in this directory will be applied for <theme> when the <locale> matches the system locale.
+This directory is located to /usr/share/themes/\<theme\>/dui/locale/\<locale\>/ where the \<locale\> is fi, en, etc. Definitions in this directory will be applied for \<theme\> when the \<locale\> matches the system locale.
 
 \subsection locale_constants Locale Specific Constants
 
@@ -206,6 +206,6 @@ This file can contain fonts and color definitions for the locale.
 
 \subsection locale_icons Locale Specific Icons Directory
 
-This directory can contain any number of icons which will override the themes icons when the locale matches the system locale setting. The icons in this folder must exist in the <a href="#theme_graphics">theme icons</a> directory.
+This directory can contain any number of icons which will override the themes icons when the locale matches the system locale setting. The icons in this folder must exist in the \ref theme_graphics "theme icons" directory.
 
 */