diff options
| author | Max Waterman <david.waterman@nokia.com> | 2010-08-11 16:19:34 +0300 |
|---|---|---|
| committer | Tomas Junnonen <tomas.junnonen@nokia.com> | 2010-08-12 11:39:45 +0300 |
| commit | d96598f986e4517968ea0ba5f6ecfca9e7ca22d3 (patch) | |
| tree | 40dbcc09fba87f3467b76d4e5bbea6f7e48eee49 /doc | |
| parent | 2da904224c48bd710e0cb2ca0f8a50225b4ea025 (diff) | |
Changes: correcting the documentation for the documentation feature of m-serfvicefwgen
RevBy: TrustMe
Details:
Interfaces can be documented using <doc> tags in the xml files, but when the feature was added, the documentation wasn't updated.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/src/servicefw.dox | 20 |
1 files changed, 19 insertions, 1 deletions
diff --git a/doc/src/servicefw.dox b/doc/src/servicefw.dox index a8c3ddb9..e40aed92 100644 --- a/doc/src/servicefw.dox +++ b/doc/src/servicefw.dox @@ -128,7 +128,25 @@ dui-servicefwgen -p com.nokia.TextProcessorInterface The above files should be made part of the maemo-interfaces package. The library should be in maemo-interfaces, and the header and xml files should be in maemo-interfaces-dev. -Documentation for an interface and its methods can be added between '<doc>' and '</doc>' tags, and the dui-servicefwgen script will copy the lines into the wrapper header file. Note that the tags need to be on their own lines. +Documentation for an interface and its methods can be added between '<doc>' and '</doc>' tags, as follows : + +\verbatim + <interface name="com.nokia.someserviceinterface"> + <doc> + <arg tag="brief">brief documentation for the interface</arg> + <arg tag="details">detailed documentation for the interface</arg> + </doc> + <method name="showPage"> + <doc> + <arg tag="brief">brief documentation for showPage() method</arg> + <arg tag="details">detailed documentation for showPage() method</arg> + </doc> + <arg name="targetPage" type="s" direction="in" /> + <arg name="previousPage" type="s" direction="in" /> + <arg name="" type="b" direction="out"/> + </method> + ....etc +\endverbatim \subsection usagesu As a Service User |