Documentation and test for String::index() and String::rindex()

[libacl.git] / doc / string.xml

diff --git a/doc/string.xml b/doc/string.xml
index 57d1060..9958702 100644 (file)
--- a/doc/string.xml
+++ b/doc/string.xml
@@ -219,9 +219,23 @@ Convert the string to all lower-case characters.
 <section>
 <heading>Searching in Strings</heading>
 <description>
-<item tag="int in(String &amp;x)">
-Find the string x within the string. Returns the index where <emph>x</emph> was
-found. Returns -1 if x was not found in the string. see also strstr().
+<item tag="int index(char c)">
+Find the character 'c' within the string. Returns the index where the first occurance of
+<emph>c</emph> was found. Returns -1 if <emph>c</emph> was not found in the string.
+See also index(3).
+</item>
+<item tag="int rindex(char c)">
+Find the character 'c' within the string. Returns the index where the last occurance of
+<emph>c</emph> was found. Returns -1 if <emph>c</emph> was not found in the string.
+See also rindex(3).
+</item>
+<item tag="int index(String &amp;x)">
+Find the first occurance of string x within the string. Returns the index where <emph>x</emph> was
+found. Returns -1 if x was not found in the string. see also strstr(3).
+</item>
+<item tag="int rindex(String &amp;x)">
+Find the last occurance of string x within the string. Returns the index where <emph>x</emph> was
+found. Returns -1 if x was not found in the string. see also strstr(3).
 </item>
 </description>
 </section>