Release-1.5.9-20090720

4 files changed, 166 insertions, 27 deletions

diff --git a/doc/config.doc b/doc/config.doc
index 7f9fe92..4679a4c 100644
--- a/doc/config.doc
+++ b/doc/config.doc
@@ -1431,6 +1431,26 @@ FILE_VERSION_INFO = "cleartool desc -fmt \%Vn"
  If non-empty doxygen will try to run qhelpgenerator on the generated
  .qhp file.
 
+\anchor cfg_searchengine
+<dt>\c SEARCHENGINE <dd>
+ \addindex SEARCHENGINE
+ The \c SEARCHENGINE tag specifies whether or not the HTML output should
+ contain a search function. Possible values are \c YES and \c NO. 
+ If set to YES, doxygen will produce a search index, and a search box at
+ the top of each page (or in the side bar in case GENERATE_TREE is enabled).
+ The search engine is implemented using javascript and DHTML and should
+ work on any modern browser. 
+
+ It is possible to search using the keyboard;
+ to jump to the search box use access key + S (what the access key is
+ depends on the OS and browser, but it is typically CTRL, ALT/option, or both).
+ Inside the search box use the cursor down key to jump into the search 
+ results window, the results can be navigated using the cursor keys.
+ Press Enter to select an item or escape to cancel the search. The
+ filter options can be selected when the cursor is inside the search box
+ by pressing Shift+cursor down. Also here use the cursor keys to 
+ select a filter and enter or escape to activate or cancel the filter option.
+
 <!--
 \anchor cfg_qthelp_file 
 <dt>\c QTHELP_FILE <dd>
@@ -1488,7 +1508,7 @@ FILE_VERSION_INFO = "cleartool desc -fmt \%Vn"
  the \ref cfg_project_name "project name".
 
 \anchor cfg_use_inline_trees
-<dt>\c USE_INLINE_TREES
+<dt>\c USE_INLINE_TREES <dd>
  \addindex USE_INLINE_TREES
 By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, 
 and Class Hierarchy pages using a tree view instead of an ordered list.
@@ -2179,21 +2199,6 @@ remove the intermediate dot files that are used to generate the various graphs.
 
 
 </dl>
-\section config_search Search engine options
-\anchor cfg_searchengine
-<dl>
-
-<dt>\c SEARCHENGINE <dd>
- \addindex SEARCHENGINE
- The \c SEARCHENGINE tag specifies whether or not the HTML output should
- contain a search facility. Possible values are \c YES and \c NO. 
- If set to YES, doxygen will produce a search index and a PHP script
- to search through the index. For this to work the documentation should
- be viewed via a web-server running PHP version 4.1.0 or higher.
- (See http://www.php.net/manual/en/installation.php for installation 
- instructions).
-
-</dl>
 <h2>Examples</h2>
 
 Suppose you have a simple project consisting of two files: a source file 
diff --git a/doc/dbusxml.doc b/doc/dbusxml.doc
new file mode 100644
index 0000000..a8710cb
--- /dev/null
+++ b/doc/dbusxml.doc
@@ -0,0 +1,141 @@
+/*! \page dbusxml DBus XML output format
+
+\addindex dbusxml
+
+<p>Doxygen can generate documentation for DBus XML files.  This way
+DBus interfaces can be annotated with doxygen style comments, and
+without writing custom XML parsers.  Doxygen extracts its text from
+all XML comments starting with '*' or '!'.  An additional '<' can be
+used to assign the documentation string to the previous entity instead
+of the one following the comment.
+
+\section dbusxml_supported Supported XML elements and attributes
+
+<p>The following DBus XML elemets can be annotated:
+
+<ul>
+<li><b>interface</b>
+
+<li><b>method</b> or <b>signal</b>
+
+<li><b>arg</b>
+
+<li><b>property</b>
+
+</ul>
+
+Additional elements are supported. These are available once
+the xmlns "http://psiamp.org/dtd/doxygen_dbusxml.dtd" is
+available.
+
+<ul>
+<li><b>namespace</b>: This can be used to group other more of the
+additional elemets.  This element requires a <b>name</b> attribute.
+
+<li><b>enum</b> is used to define enums.  <b>value</b> element is
+    then used to define the individual values in the enum.  This element
+    requires the <b>name</b> and <b>type</b> attributes.  A
+    optional <b>named-type</b> attribute is allowed, referrencing typed
+    previously defined by one of the additional elements.  A enum name
+    can be used anywhere a type is required using the <b>named-type</b>
+    attribute.
+
+<li><b>flagset</b> is used to define sets of flags. Required and
+    optional attributes are identical to the ones used by <b>enum</b>.
+    While <b>enum</b>s assume the values to be consecutive, while
+    a <b>flagset</b> is values suitable for flags.  A flagset name
+    can be used anywhere a type is required using the <b>named-type</b>
+    attribute.
+
+<li><b>struct</b> is used to define structures. A <b>name</b>
+    attribute is required.
+
+<li><b>member</b> is used to define members of <b>structs</b>.  It
+    is valid inside <b>struct</b> elements. This
+    element requires <b>name</b> and <b>type</b> attributes.  In
+    addition to (or even instead of) the <b>type</b> attribute a
+    <b>named-type</b> attribute may be used to reference types defined
+    by <b>enum</b>, <b>flagset</b> or <b>struct</b>.
+
+\section dbusxml_example Example
+
+<pre>
+<?xml version="1.0" ?>
+<!-- Comment -->
+<!--*< File comment -->
+<node name="/SomeNode" xmlns:dx="http://psiamp.org/dtd/doxygen_dbusxml.dtd">
+  <!--* test struct outside a namespace and interface -->
+  <dx:struct name="StructOutsideNamespace">
+    <!--* member 1 -->
+    <dx:member name="member1" type="s"/>
+    <!--* complex member 1 -->
+    <dx:member name="complexMember1" type="(ssu)"/>
+  </dx:struct>
+
+  <!--* Test flag set -->
+  <dx:flagset name="flagset">
+    <!--* Flag 1 of flagset. -->
+    <dx:value name="FLAG1"/>
+  </dx:flagset>
+
+  <!--* namespace comment -->
+  <dx:namespace name="SomeNamespace">
+    <!--* struct inside a namespace -->
+    <dx:struct name="StructInNamespace">
+       <!--* member 2 -->
+       <dx:member name="member2" type="s"/>
+    </dx:struct>
+  </dx:namespace>
+  <!--* Documentation on the interface -->
+  <interface name="nl.stack.doxygen.test.interface">
+    <!--* Test Enum documentation -->
+    <dx:enum name="TestEnum">
+      <!--* key 1 with value 13 -->
+      <dx:value name="KEY1" value="13"/>
+      <!--* key 2 without a value -->
+      <dx:value name="KEY2"/>
+    </dx:enum>
+
+    <!--* struct inside a interface -->
+    <dx:struct name="StructInInterface">
+      <!--* member 3 -->
+      <dx:member name="member3" type="s"/>
+      <!--* Struct in a struct -->
+      <dx:struct name="StructInAStruct">
+        <!--* member4 -->
+        <dx:member name="member4" type="s"/>
+      </dx:struct>
+      <!--* struct member -->
+      <dx:member name="structMembor" type="(s)" named-type="StructInAStruct"/>
+    </dx:struct>
+    <!--* Document method
+
+          Some extended documentation for the method.
+
+          @param[in] input blah.
+          @param[out] output blub
+     -->
+    <method name="method">
+      <arg direction="in" name="input" type="(s(s))" named-type="::nl::stack::doxygen::test::interface::StructInInterface"/>
+      <arg direction="out" type="v" name="output"/>
+    </method>
+
+    <signal name="signal">
+      <!--*< Documentation for signal.
+
+             @param parameter some parameter.
+        -->
+      <arg name="parameter" type="s"/>
+    </signal>
+
+    <!--* property documentation -->
+    <property name="property" type="s" access="readwrite"/>
+
+    <!--* property documentation read-only -->
+    <property name="propertyRead" type="s" access="read"/>
+    <!--* property documentation write-only -->
+    <property name="propertyWrite" type="s" access="write"/>
+  </interface>
+</node>
+</pre>
+*/
diff --git a/doc/installdox_usage.doc b/doc/installdox_usage.doc
index 59057b1..b1415a5 100644
--- a/doc/installdox_usage.doc
+++ b/doc/installdox_usage.doc
@@ -18,14 +18,11 @@
 
 Installdox is a perl script that is generated by doxygen whenever
 tag files are used (See \c TAGFILES
-in section \ref config_extref)
-or the search engine is enabled (See \c SEARCHENGINE
-in section \ref config_search). The script is 
+in section \ref config_extref). The script is 
 located in the same directory where the HTML files are located. 
 
 Its purpose is to set the location of the external documentation 
-for each tag file and to set the correct links to the search engine 
-at install time.
+for each tag file at install time.
 
 Calling \c installdox with option <b>-h</b> at the command line 
 will give you a brief description of the usage of the program.
diff --git a/doc/starting.doc b/doc/starting.doc
index 29ebc39..8e3e0d2 100644
--- a/doc/starting.doc
+++ b/doc/starting.doc
@@ -157,12 +157,8 @@ a browser that supports cascading style sheets (CSS) should be used
 generated output). 
 
 Some of the features the HTML section (such as 
-\ref cfg_generate_treeview "GENERATE_TREEVIEW") require a browser that
-supports DHTML and Javascript. 
-
-If you plan to use the search engine (see 
-\ref cfg_searchengine "SEARCHENGINE"), you should view the HTML output 
-via a PHP-enabled web server (e.g. apache with the PHP module installed).
+\ref cfg_generate_treeview "GENERATE_TREEVIEW" or the search engine) 
+require a browser that supports DHTML and Javascript. 
 
 \subsection latex_out LaTeX output
 \addindex LaTeX