solid/Mainpage.dox

   1 /** \mainpage Solid
   2
   3 %Solid is a device integration framework.  It provides a way of querying and
   4 interacting with hardware independently of the underlying operating system.
   5
   6 Currently, only the
   7 <a href="http://www.freedesktop.org/wiki/Software/hal">HAL</a> backend is
   8 implemented, so %Solid will only work on Linux, but more backends will follow.
   9
  10 See the documentation for the Solid namespace, and the
  11 <a href="http://techbase.kde.org/Development/Tutorials/Solid_Tutorials">tutorial
  12 on TechBase</a>.
  13
  14 Examples:
  15 - \ref tutorial1
  16 - \ref tutorial2
  17 - \ref tutorial3
  18 - \ref tutorial4
  19 - \ref tutorial5
  20
  21 Just for fun: \ref song
  22
  23
  24 \authors
  25 Kevin Ottens \<ervin@kde.org\>
  26
  27 \maintainers
  28 Kevin Ottens \<ervin@kde.org\>
  29
  30 \licenses
  31 \lgpl
  32
  33 */
  34
  35
  36 /** \page tutorial1 Tutorial 1
  37
  38 <p><b>
  39 \ref index "Back to Overview" |
  40 Tutorial 1 |
  41 \ref tutorial2 |
  42 \ref tutorial3 |
  43 \ref tutorial4 |
  44 \ref tutorial5
  45 </b></p>
  46
  47 \includelineno tutorial1/tutorial1.cpp
  48
  49 */
  50
  51
  52 /** \page tutorial2 Tutorial 2
  53
  54 <p><b>
  55 \ref index "Back to Overview" |
  56 \ref tutorial1 |
  57 Tutorial 2 |
  58 \ref tutorial3 |
  59 \ref tutorial4 |
  60 \ref tutorial5
  61 </b></p>
  62
  63 \includelineno tutorial2/tutorial2.cpp
  64
  65 */
  66
  67
  68 /** \page tutorial3 Tutorial 3
  69
  70 <p><b>
  71 \ref index "Back to Overview" |
  72 \ref tutorial1 |
  73 \ref tutorial2 |
  74 Tutorial 3 |
  75 \ref tutorial4 |
  76 \ref tutorial5
  77 </b></p>
  78
  79 \includelineno tutorial3/tutorial3.cpp
  80
  81 */
  82
  83
  84 /** \page tutorial4 Tutorial 4
  85
  86 <p><b>
  87 \ref index "Back to Overview" |
  88 \ref tutorial1 |
  89 \ref tutorial2 |
  90 \ref tutorial3 |
  91 Tutorial 4 |
  92 \ref tutorial5
  93 </b></p>
  94
  95 \includelineno tutorial4/tutorial4.cpp
  96
  97 */
  98
  99
 100 /** \page tutorial5 Tutorial 5
 101
 102 <p><b>
 103 \ref index "Back to Overview" |
 104 \ref tutorial1 |
 105 \ref tutorial2 |
 106 \ref tutorial3 |
 107 \ref tutorial4 |
 108 Tutorial 5
 109 </b></p>
 110
 111 \includelineno tutorial5/tutorial5.cpp
 112
 113 */
 114
 115
 116
 117
 118 /** \page song A Solid Song
 119
 120 <p><b>\ref index "Back to Overview"</b></p>
 121
 122 And for HAL's sake, each mistake, ah, you forgave<br>
 123 And soon both of us learned to trust<br>
 124 Not run away, it was no time to play;<br>
 125 We built it up and built it up and committed it.
 126 <p>
 127 And now it's solid,<br>
 128 %Solid as a rock;<br>
 129 That's what this code is,<br>
 130 That's what we've got, oh, mmm?
 131
 132 %Solid (Oh),<br>
 133 %Solid as a rock;<br>
 134 And nothing's changed it (Ooh),<br>
 135 The code is still hot, hot, hot, hot, hot, hot, hot, hot
 136 */
 137
 138 // DOXYGEN_SET_EXAMPLE_PATH += @topdir@/solid/examples
 139 // DOXYGEN_EXCLUDE = solid/backends solid/ifaces tests
 140 // DOXYGEN_SET_PROJECT_NAME = Solid
 141 // vim:ts=4:sw=4:expandtab:filetype=doxygen