SF.net SVN: geany-plugins:[1646] trunk/geany-plugins/geanygendoc/docs

[colombanw at users.sourceforge.net]

Revision: 1646
          http://geany-plugins.svn.sourceforge.net/geany-plugins/?rev=1646&view=rev
Author:   colombanw
Date:     2010-10-09 16:20:39 +0000 (Sat, 09 Oct 2010)

Log Message:
-----------
GeanyGenDoc: Small fixes in the manual

Modified Paths:
--------------
    trunk/geany-plugins/geanygendoc/docs/manual.html
    trunk/geany-plugins/geanygendoc/docs/manual.rst

Modified: trunk/geany-plugins/geanygendoc/docs/manual.html
===================================================================
--- trunk/geany-plugins/geanygendoc/docs/manual.html	2010-10-09 16:20:18 UTC (rev 1645)
+++ trunk/geany-plugins/geanygendoc/docs/manual.html	2010-10-09 16:20:39 UTC (rev 1646)
@@ -464,7 +464,7 @@
 <dl class="docutils">
 <dt><tt class="docutils literal">template</tt> (string)</dt>
 <dd><p class="first">A <a class="reference external" href="http://ctpl.tuxfamily.org/">CTPL</a> template that can include references to the following predefined
-variables in addition to the file-type-wide and the global environment:</p>
+variables in addition to the file-type-wide and the global environments:</p>
 <dl class="docutils">
 <dt><tt class="docutils literal">argument_list</tt> (string list)</dt>
 <dd>A list of the arguments of the currently documented symbol.</dd>
@@ -474,6 +474,8 @@
 <dt><tt class="docutils literal">children</tt> (string list)</dt>
 <dd>A list of the current symbol's first-level children. This is only set if
 the rule's setting <tt class="docutils literal">children</tt> is set to <tt class="docutils literal">MERGE</tt>.</dd>
+<dt><tt class="docutils literal">symbol</tt> (string)</dt>
+<dd>The name of the symbol that is documented.</dd>
 </dl>
 <p><strong>[...]</strong></p>
 <dl class="last docutils">
@@ -508,9 +510,9 @@
 that are documented by their parent, such as <a class="reference external" href="http://www.gtk.org/gtk-doc/">Gtk-Doc</a>'s enumerations.</dd>
 <dt><tt class="docutils literal">PASS</tt></dt>
 <dd>Completely ignore the symbol and handle the documentation request as if it
-hasn't existed at all. This can be useful to ignore e.g. variables if
-if they are extracted by the tag manager of the language, and you won't
-document them and don't want them to "eat" the documentation request.</dd>
+hasn't existed at all. This can be useful to ignore e.g. variables if they
+are extracted by the tag manager of the language and you don't want to
+document them, and don't want them to "eat" the documentation request.</dd>
 </dl>
 </dd>
 <dt><tt class="docutils literal">children</tt> (enumeration)</dt>
@@ -627,7 +629,7 @@
 </div>
 <div class="footer">
 <hr class="footer" />
-Generated on: 2010-09-18.
+Generated on: 2010-09-22.
 
 </div>
 </body>

Modified: trunk/geany-plugins/geanygendoc/docs/manual.rst
===================================================================
--- trunk/geany-plugins/geanygendoc/docs/manual.rst	2010-10-09 16:20:18 UTC (rev 1645)
+++ trunk/geany-plugins/geanygendoc/docs/manual.rst	2010-10-09 16:20:39 UTC (rev 1646)
@@ -381,7 +381,7 @@
 
 ``template`` (string)
   A CTPL_ template that can include references to the following predefined
-  variables in addition to the file-type-wide and the global environment:
+  variables in addition to the file-type-wide and the global environments:
   
   ``argument_list`` (string list)
     A list of the arguments of the currently documented symbol.
@@ -394,6 +394,9 @@
     A list of the current symbol's first-level children. This is only set if
     the rule's setting ``children`` is set to ``MERGE``.
   
+  ``symbol`` (string)
+    The name of the symbol that is documented.
+  
   **[...]**
   
   ``cursor`` (special, described below)
@@ -429,9 +432,9 @@
   
   ``PASS``
     Completely ignore the symbol and handle the documentation request as if it
-    hasn't existed at all. This can be useful to ignore e.g. variables if
-    if they are extracted by the tag manager of the language, and you won't
-    document them and don't want them to "eat" the documentation request.
+    hasn't existed at all. This can be useful to ignore e.g. variables if they
+    are extracted by the tag manager of the language and you don't want to
+    document them, and don't want them to "eat" the documentation request.
 
 ``children`` (enumeration)
   How the symbol's children can be used in the template. Possible values are:


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.