changeset 1563:d8c04a55d1d4

Move reagent pouch command documentation to tfdoc inline docs.
author Matti Hamalainen <ccr@tnsp.org>
date Fri, 19 Apr 2013 16:06:08 +0300
parents 998654bf0b6c
children f24f9b099918
files docs/manual.sgml gm-rpouch.tf
diffstat 2 files changed, 41 insertions(+), 45 deletions(-) [+]
line wrap: on
line diff
--- a/docs/manual.sgml	Fri Apr 19 16:05:53 2013 +0300
+++ b/docs/manual.sgml	Fri Apr 19 16:06:08 2013 +0300
@@ -2725,6 +2725,12 @@
 </para>
 
 <para>
+The module also supports merchant belt's 'weigh' command for catching
+the item's weight, if the belt is worn and <emphasis>/havebelt</emphasis>
+setting of the merchant module is enabled.
+</para>
+
+<para>
 Example of output:
 </para>
 <screen>
@@ -2800,51 +2806,7 @@
 this module.
 </para></note>
 
-&sectmacros_2;
-   <row>
-    <entry>/rpouch</entry>
-    <entry>Prints a short help text with basic syntaxes of the commands.</entry>
-   </row>
-   <row>
-    <entry>/rpouch check &lt;dst pouch&gt; from &lt;src pouch&gt; [in &lt;container&gt;]</entry>
-    <entry>Checks and shows a list of reagents to be stocked into "dst pouch"
-    from "src pouch" with current settings. Source pouch can optionally be
-    in container (such as a chest).</entry>
-   </row>
-   <row>
-    <entry>/rpouch fill &lt;dst pouch&gt; from &lt;src pouch&gt; [in &lt;container&gt;]</entry>
-    <entry>Like 'check' but instead of a list, moves reagents to "dst pouch"
-    to match the current settings.</entry>
-   </row>
-   <row>
-    <entry>/rpouch move &lt;dst pouch&gt; from &lt;src pouch&gt; [in &lt;container&gt;]</entry>
-    <entry>Moves ALL power reagents from "src pouch" to "dst pouch".</entry>
-   </row>
-   <row>
-    <entry>/rpouch set &lt;spell&gt; &lt;amount&gt;</entry>
-    <entry>Set amount of reagents to stock for given spell. (Like "rset",
-    but takes spell name instead.)</entry>
-   </row>
-   <row>
-    <entry>/rpouch rset &lt;reagent&gt; &lt;amount&gt;</entry>
-    <entry>Set amount of given reagent to be stocked. (Like "set", but takes
-    reagent name instead.)</entry>
-   </row>
-   <row>
-    <entry>/rpouch adjust &lt;amount&gt;</entry>
-    <entry>???</entry>
-   </row>
-   <row>
-    <entry>/rpouch all &lt;amount&gt;</entry>
-    <entry>Unconditionally sets number of ALL reagents to be stocked to
-    given amount.</entry>
-   </row>
-   <row>
-    <entry>/rpouch list</entry>
-    <entry>Shows a list of current settings (e.g. how many of each reagent to
-    stock.)</entry>
-   </row>
-&sectmacros_end;
+<!-- @commands -->
 
 </section>
 
--- a/gm-rpouch.tf	Fri Apr 19 16:05:53 2013 +0300
+++ b/gm-rpouch.tf	Fri Apr 19 16:06:08 2013 +0300
@@ -265,6 +265,40 @@
 	/endif
 
 
+;@command /rpouch
+;@desc Prints a short help text with basic syntaxes of the commands.
+
+;@command /rpouch check <dst pouch> from <src pouch> [in <container>]
+;@desc Checks and shows a list of reagents to be stocked into "dst pouch"
+;@desc from "src pouch" with current settings. Source pouch can optionally be
+;@desc in container (such as a chest).
+
+;@command /rpouch fill &lt;dst pouch&gt; from &lt;src pouch&gt; [in &lt;container&gt;]
+;@desc Like 'check' but instead of a list, moves reagents to "dst pouch"
+;@desc to match the current settings.
+
+;@command /rpouch move &lt;dst pouch&gt; from &lt;src pouch&gt; [in &lt;container&gt;]
+;@desc Moves ALL power reagents from "src pouch" to "dst pouch".
+
+;@command /rpouch set &lt;spell&gt; &lt;amount&gt;
+;@desc Set amount of reagents to stock for given spell. (Like "rset",
+;@desc but takes spell name instead.)
+
+;@command /rpouch rset &lt;reagent&gt; &lt;amount&gt;
+;@desc Set amount of given reagent to be stocked. (Like "set", but takes
+;@desc reagent name instead.)
+
+;@command /rpouch adjust &lt;amount&gt;
+;@desc ???
+
+;@command /rpouch all &lt;amount&gt;
+;@desc Unconditionally sets number of ALL reagents to be stocked to
+;@desc given amount.
+
+;@command /rpouch list
+;@desc Shows a list of current settings (e.g. how many of each reagent to stock.)
+
+
 ;; Main command interface
 /def -i rpouch =\
 	/let _args=$[tolower({*})]%;\