ZF-8958 #comment modificaions to chapter for Zend_Filter_Alpha and also got rid of a problem still being reported by the doc checker in Zend_Filter_BaseName doc.

git-svn-id: http://framework.zend.com/svn/framework/standard/trunk@22247 44c647ce-9c0f-0410-b52a-842ac1e357ba

documentation/manual/en/module_specs/Zend_Filter-Alpha.xml

@@ -1,11 +1,12 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!-- Reviewed: no -->
 <sect2 id="zend.filter.set.alpha">
-    <title>Alnum</title>
+    <title>Alpha</title>
 
     <para>
-        <classname>Zend_Filter_Alpha</classname> is a filter which returns the string <varname>$value</varname>,
-        removing all but alphabetic characters. This filter includes an option to also allow white space characters.
+        <classname>Zend_Filter_Alpha</classname> is a filter which returns the string
+        <varname>$value</varname>, removing all but alphabetic characters. This filter includes an
+        option to also allow white space characters.
     </para>
 
     <sect3 id="zend.filter.set.alpha.options">
@@ -18,9 +19,9 @@
         <itemizedlist>
             <listitem>
                 <para>
-                    <emphasis><property>allowwhitespace</property></emphasis>: If this option is set
-                    then whitespace characters are allowed. Otherwise they are suppressed. Per default
-                    whitespace characters are not allowed.
+                    <emphasis><property>allowwhitespace</property></emphasis>: If this option is
+                    set then whitespace characters are allowed. Otherwise they are suppressed. By
+                    default whitespace characters are not allowed.
                 </para>
             </listitem>
         </itemizedlist>
@@ -30,13 +31,13 @@
         <title>Basic usage</title>
 
         <para>
-            See the following example for the default behaviour of this filter.
+            A basic example of usage is below:
         </para>
 
         <programlisting language="php"><![CDATA[
 $filter = new Zend_Filter_Alpha();
-$return = $filter->filter('This is (my) content: 123');
-// returns 'Thisismycontent'
+
+print $filter->filter('This is (my) content: 123');
 ]]></programlisting>
 
         <para>
@@ -46,25 +47,27 @@ $return = $filter->filter('This is (my) content: 123');
 
         <note>
             <para>
-                <classname>Zend_Filter_Alpha</classname> works on most languages; however, there are
-                three exceptions: Chinese, Japanese and Korean. With these languages the english alphabet
-                is used. The language is detected through the use of <classname>Zend_Locale</classname>.
+                <classname>Zend_Filter_Alpha</classname> works on most languages; however, there
+                are three exceptions: Chinese, Japanese and Korean. With these languages the
+                english alphabet is used. The language is detected through the use of
+                <classname>Zend_Locale</classname>.
             </para>
         </note>
     </sect3>
 
-    <sect3 id="zend.filter.set.alpha.whitespace">
-        <title>Allow whitespace characters</title>
+     <sect3 id="zend.filter.set.alpha.whitespace">
+         <title>Allow whitespace characters</title>
 
         <para>
-            <classname>Zend_Filter_Alpha</classname> can also allow whitespace characters. This can be
-            useful when you want to strip special characters from a string. See the following example:
+            <classname>Zend_Filter_Alpha</classname> can also allow whitespace characters. This can
+            be useful when you want to strip special characters from a string. See the following
+            example:
         </para>
 
         <programlisting language="php"><![CDATA[
 $filter = new Zend_Filter_Alpha(array('allowwhitespace' => true));
-$return = $filter->filter('This is (my) content: 123');
-// returns 'This is my content '
+
+print $filter->filter('This is (my) content: 123');
 ]]></programlisting>
 
         <para>
@@ -74,12 +77,12 @@ $return = $filter->filter('This is (my) content: 123');
 
         <para>
             To change <property>allowWhiteSpace</property> after instantiation the method
-            <methodname>setAllowWhiteSpace</methodname> may be used.
+            <methodname>setAllowWhiteSpace()</methodname> may be used.
         </para>
 
         <para>
             To query the current value of <property>allowWhiteSpace</property> the method
-            <methodname>getAllowWhiteSpace</methodname> may be used.
+            <methodname>getAllowWhiteSpace()</methodname> may be used.
         </para>
     </sect3>
 </sect2>

documentation/manual/en/module_specs/Zend_Filter-BaseName.xml

@@ -40,7 +40,7 @@ print $filter->filter('/vol/tmp/filename.txt');
 ]]></programlisting>
 
         <para>
-            This will return 'filename.txt'.
+            This will return '<filename>filename.txt</filename>'.
         </para>
     </sect3>
 </sect2>