Explorar el Código

[DOCUMENTATION] English:
- manual fixes: <code>class name</code> => <classname>class name</classname>

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

mikaelkael hace 16 años
padre
commit
e11f253cb9

+ 1 - 1
documentation/manual/en/module_specs/Zend_Form-Elements.xml

@@ -1429,7 +1429,7 @@ $form->addPrefixPath('My_Element', 'My/Element/', 'element')
 ]]></programlisting>
 
         <para>
-            The 'foo' element will now be of type <code>My_Element_Text</code>,
+            The 'foo' element will now be of type <classname>My_Element_Text</classname>,
             and exhibit the behaviour you've outlined.
         </para>
 

+ 1 - 1
documentation/manual/en/module_specs/Zend_Ldap-API-Ldap-Attribute.xml

@@ -4,7 +4,7 @@
     <title>Zend_Ldap_Attribute</title>
 
     <para>
-        <code>Zend_Ldap_Attribute</code> is a helper class providing only static
+        <classname>Zend_Ldap_Attribute</classname> is a helper class providing only static
         methods to manipulate arrays suitable to the structure used in
         <classname>Zend_Ldap</classname> data modification methods and to the data format required by
         the <acronym>LDAP</acronym> server. PHP data types are converted the following way:

+ 3 - 3
documentation/manual/en/module_specs/Zend_Ldap-API-Ldap-Node-RootDse.xml

@@ -6,7 +6,7 @@
     <para>The following methods are available on all vendor-specific subclasses.</para>
 
     <para>
-        <code>Zend_Ldap_Node_RootDse</code> includes the magic propery accessors
+        <classname>Zend_Ldap_Node_RootDse</classname> includes the magic propery accessors
         <code>__get()</code> and <code>__isset()</code> to access the attributes by their
         name. They proxy to <code>Zend_Ldap_Node_RootDse::getAttribute()</code> and
         <code>Zend_Ldap_Node_RootDse::existsAttribute()</code> respectively.
@@ -253,7 +253,7 @@
 
         <para>
             Additionally the common methods above apply to instances of
-            <code>Zend_Ldap_Node_RootDse_OpenLdap</code>.
+            <classname>Zend_Ldap_Node_RootDse_OpenLdap</classname>.
         </para>
 
         <note>
@@ -322,7 +322,7 @@
 
         <para>
             Additionally the common methods above apply to instances of
-            <code>Zend_Ldap_Node_RootDse_ActiveDirectory</code>.
+            <classname>Zend_Ldap_Node_RootDse_ActiveDirectory</classname>.
         </para>
 
         <note>

+ 11 - 11
documentation/manual/en/module_specs/Zend_Ldap-API-Ldap-Node.xml

@@ -4,7 +4,7 @@
     <title>Zend_Ldap_Node</title>
 
     <para>
-        <code>Zend_Ldap_Node</code> includes the magic propery accessors
+        <classname>Zend_Ldap_Node</classname> includes the magic propery accessors
         <code>__set()</code>, <code>__get()</code>, <code>__unset()</code> and
         <code>__isset()</code> to access the attributes by their name. They proxy to
         <code>Zend_Ldap_Node::setAttribute()</code>,
@@ -12,7 +12,7 @@
         <code>Zend_Ldap_Node::deleteAttribute()</code> and
         <code>Zend_Ldap_Node::existsAttribute()</code> respectively. Furthermore the class
         implements <code>ArrayAccess</code> for array-style-access to the attributes.
-        <code>Zend_Ldap_Node</code> also implements <code>Iterator</code> and
+        <classname>Zend_Ldap_Node</classname> also implements <code>Iterator</code> and
         <code>RecursiveIterato</code> to allow for recursive tree-traversal.
     </para>
 
@@ -31,7 +31,7 @@
                     <entry><code>Zend_Ldap getLdap()</code></entry>
                     <entry>
                         Returns the current <acronym>LDAP</acronym> connection. Throws
-                        <code>Zend_Ldap_Exception</code> if current node is in detached
+                        <classname>Zend_Ldap_Exception</classname> if current node is in detached
                         mode (not connected to a <classname>Zend_Ldap</classname> instance).
                     </entry>
                 </row>
@@ -43,7 +43,7 @@
                     <entry>
                         Attach the current node to the <code>$ldap</code>
                         <classname>Zend_Ldap</classname> instance. Throws
-                        <code>Zend_Ldap_Exception</code> if <code>$ldap</code> is not
+                        <classname>Zend_Ldap_Exception</classname> if <code>$ldap</code> is not
                         responsible for the current node (node is not a child of the
                         <code>$ldap</code> base DN).
                     </entry>
@@ -67,8 +67,8 @@
                     </entry>
                     <entry>
                         Factory method to create a new detached
-                        <code>Zend_Ldap_Node</code> for a given DN. Creates a new
-                        <code>Zend_Ldap_Node</code> with the DN <code>$dn</code> and the
+                        <classname>Zend_Ldap_Node</classname> for a given DN. Creates a new
+                        <classname>Zend_Ldap_Node</classname> with the DN <code>$dn</code> and the
                         object-classes <code>$objectClass</code>.
                     </entry>
                 </row>
@@ -80,8 +80,8 @@
                     </entry>
                     <entry>
                         Factory method to create an attached
-                        <code>Zend_Ldap_Node</code> for a given DN. Loads an existing
-                        <code>Zend_Ldap_Node</code> with the DN <code>$dn</code> from the
+                        <classname>Zend_Ldap_Node</classname> for a given DN. Loads an existing
+                        <classname>Zend_Ldap_Node</classname> with the DN <code>$dn</code> from the
                         <acronym>LDAP</acronym> connection <code>$ldap</code>.
                     </entry>
                 </row>
@@ -92,7 +92,7 @@
                     </entry>
                     <entry>
                         Factory method to create a detached
-                        <code>Zend_Ldap_Node</code> from array data <code>$data</code>. If
+                        <classname>Zend_Ldap_Node</classname> from array data <code>$data</code>. If
                         <code>$fromDataSource</code> is <code>true</code>
                         (<code>false</code> by default), the data is treated as beeing
                         present in a <acronym>LDAP</acronym> tree.
@@ -135,7 +135,7 @@
                         Sends all pending changes to the <acronym>LDAP</acronym> server. If
                         <code>$ldap</code> is omitted the current <acronym>LDAP</acronym> connection is used.
                         If the current node is detached from a <acronym>LDAP</acronym> connection a
-                        <code>Zend_Ldap_Exception</code> will be thrown. If
+                        <classname>Zend_Ldap_Exception</classname> will be thrown. If
                         <code>$ldap</code> is provided the current node will be attached to
                         the given <acronym>LDAP</acronym> connection.
                     </entry>
@@ -235,7 +235,7 @@
                     <entry>
                         Returns a <acronym>LDIF</acronym> representation of the current node.
                         <code>$options</code> will be passed to the
-                        <code>Zend_Ldap_Ldif_Encoder</code>.
+                        <classname>Zend_Ldap_Ldif_Encoder</classname>.
                     </entry>
                 </row>
                 <row>

+ 13 - 13
documentation/manual/en/module_specs/Zend_Ldap-API-Ldap.xml

@@ -241,10 +241,10 @@
                                     <para>
                                         If given the result will be wrapped in an object
                                         of type <code>$collectionClass</code>. By default an object
-                                        of type <code>Zend_Ldap_Collection</code> will be returned.
+                                        of type <classname>Zend_Ldap_Collection</classname> will be returned.
                                         The custom class must extend
-                                        <code>Zend_Ldap_Collection</code> and will be passed a
-                                        <code>Zend_Ldap_Collection_Iterator_Default</code> on
+                                        <classname>Zend_Ldap_Collection</classname> and will be passed a
+                                        <classname>Zend_Ldap_Collection_Iterator_Default</classname> on
                                         instantiation.
                                     </para>
                                 </listitem>
@@ -308,7 +308,7 @@
                         <code>$throwOnNotFound</code> is <code>false</code> by default, so
                         the method will return <code>null</code> if the specified entry
                         cannot be found. If set to <code>true</code>, a
-                        <code>Zend_Ldap_Exception</code> will be thrown instead.
+                        <classname>Zend_Ldap_Exception</classname> will be thrown instead.
                     </entry>
                 </row>
                 <row>
@@ -331,7 +331,7 @@
                     <entry>
                         Adds the entry identified by <code>$dn</code> with its
                         attributes <code>$entry</code> to the <acronym>LDAP</acronym> tree. Throws a
-                        <code>Zend_Ldap_Exception</code> if the entry could not be
+                        <classname>Zend_Ldap_Exception</classname> if the entry could not be
                         added.
                     </entry>
                 </row>
@@ -343,7 +343,7 @@
                     <entry>
                         Updates the entry identified by <code>$dn</code> with its
                         attributes <code>$entry</code> to the <acronym>LDAP</acronym> tree. Throws a
-                        <code>Zend_Ldap_Exception</code> if the entry could not be
+                        <classname>Zend_Ldap_Exception</classname> if the entry could not be
                         modified.
                     </entry>
                 </row>
@@ -355,7 +355,7 @@
                     <entry>
                         Saves the entry identified by <code>$dn</code> with its
                         attributes <code>$entry</code> to the <acronym>LDAP</acronym> tree. Throws a
-                        <code>Zend_Ldap_Exception</code> if the entry could not be saved.
+                        <classname>Zend_Ldap_Exception</classname> if the entry could not be saved.
                         This method decides by querying the <acronym>LDAP</acronym> tree if the entry will be
                         added or updated.
                     </entry>
@@ -367,7 +367,7 @@
                     </entry>
                     <entry>
                         Deletes the entry identified by <code>$dn</code> from the
-                        <acronym>LDAP</acronym> tree. Throws a <code>Zend_Ldap_Exception</code> if the entry
+                        <acronym>LDAP</acronym> tree. Throws a <classname>Zend_Ldap_Exception</classname> if the entry
                         could not be deleted. <code>$recursively</code> is
                         <code>false</code> by default. If set to <code>true</code> the
                         deletion will be carried out recursively and will effectively
@@ -476,14 +476,14 @@
                     </entry>
                     <entry>
                         Returns the entry <code>$dn</code> wrapped in a
-                        <code>Zend_Ldap_Node</code>.
+                        <classname>Zend_Ldap_Node</classname>.
                     </entry>
                 </row>
                 <row>
                     <entry><code>Zend_Ldap_Node getBaseNode()</code></entry>
                     <entry>
                         Returns the entry for the base DN <code>$baseDn</code>
-                        wrapped in a <code>Zend_Ldap_Node</code>.
+                        wrapped in a <classname>Zend_Ldap_Node</classname>.
                     </entry>
                 </row>
                 <row>
@@ -502,7 +502,7 @@
         <title>Zend_Ldap_Collection</title>
 
         <para>
-            <code>Zend_Ldap_Collection</code> implements <code>Iterator</code> to
+            <classname>Zend_Ldap_Collection</classname> implements <code>Iterator</code> to
             allow for item traversal using <code>foreach()</code> and
             <code>Countable</code> to be able to respond to <code>count()</code>. With its
             protected <code>_createEntry()</code> method it provides a simple extension
@@ -527,9 +527,9 @@
                     </entry>
                     <entry>
                         Constructor. The constrcutor must be provided by a
-                        <code>Zend_Ldap_Collection_Iterator_Interface</code> which does the
+                        <classname>Zend_Ldap_Collection_Iterator_Interface</classname> which does the
                         real result iteration.
-                        <code>Zend_Ldap_Collection_Iterator_Default</code> is the default
+                        <classname>Zend_Ldap_Collection_Iterator_Default</classname> is the default
                         implementation for iterating ext/ldap results.
                     </entry>
                 </row>

+ 26 - 26
documentation/manual/en/module_specs/Zend_Reflection-Reference.xml

@@ -4,7 +4,7 @@
     <title>Zend_Reflection Reference</title>
 
     <para>
-        The various classes in <code>Zend_Reflection</code> mimic the API of
+        The various classes in <classname>Zend_Reflection</classname> mimic the API of
         PHP's <ulink url="http://php.net/reflection">Reflection API</ulink> -
         with one important difference. PHP's Reflection API does not provide
         introspection into docblock annotation tags, nor into parameter variable
@@ -12,7 +12,7 @@
     </para>
 
     <para>
-        <code>Zend_Reflection</code> analyzes method docblock annotations to
+        <classname>Zend_Reflection</classname> analyzes method docblock annotations to
         determine parameter variable types and the return type. Specifically,
         the <code>@param</code> and <code>@return</code> annotations are used.
         However, you can also check for any other annotation tags, as well as
@@ -20,14 +20,14 @@
     </para>
 
     <para>
-        Each reflection object in <code>Zend_Reflection</code> overrides the
+        Each reflection object in <classname>Zend_Reflection</classname> overrides the
         <code>getDocblock()</code> method to return an instance of
-        <code>Zend_Reflection_Docblock</code>. This class provides introspection
+        <classname>Zend_Reflection_Docblock</classname>. This class provides introspection
         into the docblocks and annotation tags.
     </para>
 
     <para>
-        <code>Zend_Reflection_File</code> is a new reflection class that allows
+        <classname>Zend_Reflection_File</classname> is a new reflection class that allows
         introspection of PHP files. With it, you can retrieve the classes,
         functions, and global PHP code contained in the file.
     </para>
@@ -42,8 +42,8 @@
         <title>Zend_Reflection_Docblock</title>
 
         <para>
-            <code>Zend_Reflection_Docblock</code> is the heart of
-            <code>Zend_Reflection</code>'s value-add over PHP's Reflection API.
+            <classname>Zend_Reflection_Docblock</classname> is the heart of
+            <classname>Zend_Reflection</classname>'s value-add over PHP's Reflection API.
             It provides the following methods:
         </para>
 
@@ -88,7 +88,7 @@
                 <code>getTags($filter)</code>: Retrieve all tags, or all tags
                 matching the given <code>$filter</code> string. The tags
                 returned will be an array of
-                <code>Zend_Reflection_Docblock_Tag</code> objects.
+                <classname>Zend_Reflection_Docblock_Tag</classname> objects.
             </para></listitem>
         </itemizedlist>
     </sect2>
@@ -97,7 +97,7 @@
         <title>Zend_Reflection_Docblock_Tag</title>
 
         <para>
-            <code>Zend_Reflection_Docblock_Tag</code> provides reflection for
+            <classname>Zend_Reflection_Docblock_Tag</classname> provides reflection for
             individual annotation tags. Most tags consist of only a name and a
             description. In the case of some special tags, the class provides a
             factory method for retrieving an instance of the appropriate class.
@@ -105,7 +105,7 @@
 
         <para>
             The following methods are defined for
-            <code>Zend_Reflection_Docblock_Tag</code>:
+            <classname>Zend_Reflection_Docblock_Tag</classname>:
         </para>
 
         <itemizedlist>
@@ -129,11 +129,11 @@
         <title>Zend_Reflection_Docblock_Tag_Param</title>
 
         <para>
-            <code>Zend_Reflection_Docblock_Tag_Param</code> is a specialized
-            version of <code>Zend_Reflection_Docblock_Tag</code>. The
+            <classname>Zend_Reflection_Docblock_Tag_Param</classname> is a specialized
+            version of <classname>Zend_Reflection_Docblock_Tag</classname>. The
             <code>@param</code> annotation tag description consists of the
             parameter type, variable name, and variable description. It adds the
-            following methods to <code>Zend_Reflection_Docblock_Tag</code>:
+            following methods to <classname>Zend_Reflection_Docblock_Tag</classname>:
         </para>
 
         <itemizedlist>
@@ -152,12 +152,12 @@
         <title>Zend_Reflection_Docblock_Tag_Return</title>
 
         <para>
-            Like <code>Zend_Reflection_Docblock_Tag_Param</code>,
-            <code>Zend_Reflection_Docblock_Tag_Return</code> is a specialized
-            version of <code>Zend_Reflection_Docblock_Tag</code>. The
+            Like <classname>Zend_Reflection_Docblock_Tag_Param</classname>,
+            <classname>Zend_Reflection_Docblock_Tag_Return</classname> is a specialized
+            version of <classname>Zend_Reflection_Docblock_Tag</classname>. The
             <code>@return</code> annotation tag description consists of the
             return type and variable description. It adds the following method
-            to <code>Zend_Reflection_Docblock_Tag</code>:
+            to <classname>Zend_Reflection_Docblock_Tag</classname>:
         </para>
 
         <itemizedlist>
@@ -171,7 +171,7 @@
         <title>Zend_Reflection_File</title>
 
         <para>
-            <code>Zend_Reflection_File</code> provides introspection into PHP
+            <classname>Zend_Reflection_File</classname> provides introspection into PHP
             files. With it, you can introspect the classes, functions, and bare
             PHP code defined in a file. It defines the following methods:
         </para>
@@ -227,10 +227,10 @@
         <title>Zend_Reflection_Class</title>
 
         <para>
-            <code>Zend_Reflection_Class</code> extends
+            <classname>Zend_Reflection_Class</classname> extends
             <code>ReflectionClass</code>, and follows its API. It adds one
             additional method, <code>getDeclaringFile()</code>, which may be
-            used to retrieve the <code>Zend_Reflection_File</code> reflection
+            used to retrieve the <classname>Zend_Reflection_File</classname> reflection
             object for the defining file.
         </para>
 
@@ -282,7 +282,7 @@
         <title>Zend_Reflection_Extension</title>
 
         <para>
-            <code>Zend_Reflection_Extension</code> extends
+            <classname>Zend_Reflection_Extension</classname> extends
             <code>ReflectionExtension</code>, and follows its API. It overrides
             the following methods to add an additional argument for specifying
             the reflection class to use when fetching a reflection object:
@@ -309,7 +309,7 @@
         <title>Zend_Reflection_Function</title>
 
         <para>
-            <code>Zend_Reflection_Function</code> adds a method for retrieving
+            <classname>Zend_Reflection_Function</classname> adds a method for retrieving
             the function return type, as well as overrides several methods to
             allow specifying the reflection class to use for returned reflection
             objects.
@@ -339,8 +339,8 @@
         <title>Zend_Reflection_Method</title>
 
         <para>
-            <code>Zend_Reflection_Method</code> mirrors
-            <code>Zend_Reflection_Function</code>, and only overrides one
+            <classname>Zend_Reflection_Method</classname> mirrors
+            <classname>Zend_Reflection_Function</classname>, and only overrides one
             additional method:
         </para>
 
@@ -357,7 +357,7 @@
         <title>Zend_Reflection_Parameter</title>
 
         <para>
-            <code>Zend_Reflection_Parameter</code> adds a method for retrieving
+            <classname>Zend_Reflection_Parameter</classname> adds a method for retrieving
             the parameter type, as well as overrides methods to allow specifying
             the reflection class to use on returned reflection objects.
         </para>
@@ -391,7 +391,7 @@
         <title>Zend_Reflection_Property</title>
 
         <para>
-            <code>Zend_Reflection_Property</code> overrides a single method in
+            <classname>Zend_Reflection_Property</classname> overrides a single method in
             order to allow specifying the returned reflection object class:
         </para>
 

+ 1 - 1
documentation/manual/en/module_specs/Zend_Search_Lucene-Searching.xml

@@ -417,7 +417,7 @@ $highlightedHTML = $query->highlightMatches($sourceHTML);
         </para>
         <para>
             Optional third parameter is a highlighter object which has to implement
-            <code>Zend_Search_Lucene_Search_Highlighter_Interface</code> interface:
+            <classname>Zend_Search_Lucene_Search_Highlighter_Interface</classname> interface:
             <programlisting language="php"><![CDATA[
 interface Zend_Search_Lucene_Search_Highlighter_Interface
 {