Sfoglia il codice sorgente

[DOCUMENTATION] English:
- manual fixes

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

mikaelkael 16 anni fa
parent
commit
4db220bca7

+ 1 - 1
documentation/manual/en/module_specs/Zend_Captcha-Adapters.xml

@@ -152,7 +152,7 @@
             <listitem><para>
             <listitem><para>
                 <methodname>setGcFreq($gcFreq)</methodname> and <methodname>getGcFreg()</methodname>
                 <methodname>setGcFreq($gcFreq)</methodname> and <methodname>getGcFreg()</methodname>
                 allow you to specify how frequently garbage collection should
                 allow you to specify how frequently garbage collection should
-                run. Garbage collection will run every <emphasis>1/$gcFreq</emphasis>
+                run. Garbage collection will run every <command>1/$gcFreq</command>
                 calls. The default is 100.
                 calls. The default is 100.
             </para></listitem>
             </para></listitem>
 
 

+ 2 - 2
documentation/manual/en/module_specs/Zend_Config-TheoryOfOperation.xml

@@ -35,7 +35,7 @@
     <para>
     <para>
         By default, configuration data made available through <classname>Zend_Config</classname> are
         By default, configuration data made available through <classname>Zend_Config</classname> are
         read-only, and an assignment (e.g.,
         read-only, and an assignment (e.g.,
-        <command>$config->database->host = 'example.com'</command>)
+        <command>$config->database->host = 'example.com';</command>)
         results in a thrown exception. This default behavior may be overridden through the
         results in a thrown exception. This default behavior may be overridden through the
         constructor, however, to allow modification of data values. Also, when modifications are
         constructor, however, to allow modification of data values. Also, when modifications are
         allowed, <classname>Zend_Config</classname> supports unsetting of values (i.e.
         allowed, <classname>Zend_Config</classname> supports unsetting of values (i.e.
@@ -85,7 +85,7 @@
         object using the <methodname>merge()</methodname> function. For example, given
         object using the <methodname>merge()</methodname> function. For example, given
         <varname>$config</varname> and <varname>$localConfig</varname>, you can merge data from
         <varname>$config</varname> and <varname>$localConfig</varname>, you can merge data from
         <varname>$localConfig</varname> to <varname>$config</varname> using
         <varname>$localConfig</varname> to <varname>$config</varname> using
-        <methodname>$config->merge($localConfig)</methodname>. The items in
+        <command>$config->merge($localConfig);</command>. The items in
         <varname>$localConfig</varname> will override any items with the same name in
         <varname>$localConfig</varname> will override any items with the same name in
         <varname>$config</varname>.
         <varname>$config</varname>.
     </para>
     </para>

+ 4 - 4
documentation/manual/en/module_specs/Zend_Config_Ini.xml

@@ -33,7 +33,7 @@
         <para>
         <para>
             By default, the key separator character is the period character
             By default, the key separator character is the period character
             ("<emphasis>.</emphasis>"). This can be changed, however, by changing the
             ("<emphasis>.</emphasis>"). This can be changed, however, by changing the
-            <varname>$options</varname> key <emphasis>'nestSeparator'</emphasis> when constructing
+            <varname>$options</varname> key <property>nestSeparator</property> when constructing
             the <classname>Zend_Config_Ini</classname> object. For example:
             the <classname>Zend_Config_Ini</classname> object. For example:
         </para>
         </para>
 
 
@@ -117,12 +117,12 @@ echo $config->database->params->dbname; // prints "dbname"
                     </entry>
                     </entry>
                 </row>
                 </row>
                 <row>
                 <row>
-                    <entry><varname>$options = false</varname></entry>
+                    <entry><varname>$options</varname> (default <constant>FALSE</constant>)</entry>
                     <entry>Options array. The following keys are supported:
                     <entry>Options array. The following keys are supported:
                         <itemizedlist>
                         <itemizedlist>
                             <listitem>
                             <listitem>
                                 <para>
                                 <para>
-                                    <emphasis>allowModifications</emphasis>: Set to
+                                    <property>allowModifications</property>: Set to
                                     <constant>TRUE</constant> to allow
                                     <constant>TRUE</constant> to allow
                                     subsequent modification of loaded file. Defaults to
                                     subsequent modification of loaded file. Defaults to
                                     <constant>NULL</constant>
                                     <constant>NULL</constant>
@@ -130,7 +130,7 @@ echo $config->database->params->dbname; // prints "dbname"
                             </listitem>
                             </listitem>
                             <listitem>
                             <listitem>
                                 <para>
                                 <para>
-                                    <emphasis>nestSeparator</emphasis>: Set to the character to be
+                                    <property>nestSeparator</property>: Set to the character to be
                                     used as the nest separator. Defaults to "."
                                     used as the nest separator. Defaults to "."
                                 </para>
                                 </para>
                             </listitem>
                             </listitem>

+ 1 - 1
documentation/manual/en/module_specs/Zend_Config_Writer.xml

@@ -47,7 +47,7 @@
         the parameter of the <classname>Zend_Config</classname> object via the parameter
         the parameter of the <classname>Zend_Config</classname> object via the parameter
         accessor (<emphasis>-&gt;</emphasis>). To create a section in the root or to
         accessor (<emphasis>-&gt;</emphasis>). To create a section in the root or to
         create a branch, you just create a new array
         create a branch, you just create a new array
-        ("<command>$config-&gt;branch = array()</command>"). To define which section
+        ("<command>$config-&gt;branch = array();</command>"). To define which section
         extends another one, you call the <methodname>setExtend()</methodname> method
         extends another one, you call the <methodname>setExtend()</methodname> method
         on the root <classname>Zend_Config</classname> object.
         on the root <classname>Zend_Config</classname> object.
     </para>
     </para>

+ 1 - 1
documentation/manual/en/module_specs/Zend_Controller-ActionHelpers-ViewRenderer.xml

@@ -73,7 +73,7 @@
             <para>
             <para>
                 The <emphasis>ViewRenderer</emphasis> is enabled by default. You may
                 The <emphasis>ViewRenderer</emphasis> is enabled by default. You may
                 disable it via the front controller <emphasis>noViewRenderer</emphasis>
                 disable it via the front controller <emphasis>noViewRenderer</emphasis>
-                param (<methodname>$front->setParam('noViewRenderer', true)</methodname>) or
+                param (<command>$front->setParam('noViewRenderer', true);</command>) or
                 removing the helper from the helper broker stack
                 removing the helper from the helper broker stack
                 (<methodname>Zend_Controller_Action_HelperBroker::removeHelper('viewRenderer')</methodname>).
                 (<methodname>Zend_Controller_Action_HelperBroker::removeHelper('viewRenderer')</methodname>).
             </para>
             </para>

+ 14 - 7
documentation/manual/en/module_specs/Zend_Controller-FrontController.xml

@@ -279,7 +279,8 @@ Zend_Controller_Front::run('../application/controllers');
 
 
             <listitem>
             <listitem>
                 <para>
                 <para>
-                    <methodname>(set|get)DefaultControllerName()</methodname> let you
+                    <methodname>setDefaultControllerName()</methodname> and
+                    <methodname>getDefaultControllerName()</methodname> let you
                     specify a different name to use for the default controller
                     specify a different name to use for the default controller
                     ('index' is used otherwise) and retrieve the current value.
                     ('index' is used otherwise) and retrieve the current value.
                     They proxy to <link linkend="zend.controller.dispatcher">the dispatcher</link>.
                     They proxy to <link linkend="zend.controller.dispatcher">the dispatcher</link>.
@@ -288,7 +289,8 @@ Zend_Controller_Front::run('../application/controllers');
 
 
             <listitem>
             <listitem>
                 <para>
                 <para>
-                    <methodname>(set|get)DefaultAction()</methodname> let you specify a
+                    <methodname>setDefaultAction()</methodname> and
+                    <methodname>getDefaultAction()</methodname> let you specify a
                     different name to use for the default action ('index' is
                     different name to use for the default action ('index' is
                     used otherwise) and retrieve the current value. They proxy
                     used otherwise) and retrieve the current value. They proxy
                     to <link linkend="zend.controller.dispatcher">the dispatcher</link>.
                     to <link linkend="zend.controller.dispatcher">the dispatcher</link>.
@@ -297,7 +299,8 @@ Zend_Controller_Front::run('../application/controllers');
 
 
             <listitem>
             <listitem>
                 <para>
                 <para>
-                    <methodname>(set|get)Request()</methodname> let you specify <link
+                    <methodname>setRequest()</methodname> and
+                    <methodname>getRequest()</methodname> let you specify <link
                         linkend="zend.controller.request">the request</link>
                         linkend="zend.controller.request">the request</link>
                     class or object to use during the dispatch process and to
                     class or object to use during the dispatch process and to
                     retrieve the current object. When setting the request
                     retrieve the current object. When setting the request
@@ -308,7 +311,8 @@ Zend_Controller_Front::run('../application/controllers');
 
 
             <listitem>
             <listitem>
                 <para>
                 <para>
-                    <methodname>(set|get)Router()</methodname> let you specify <link
+                    <methodname>setRouter()</methodname>
+                    <methodname>getRouter()</methodname> let you specify <link
                         linkend="zend.controller.router">the router</link>
                         linkend="zend.controller.router">the router</link>
                     class or object to use during the dispatch process and to
                     class or object to use during the dispatch process and to
                     retrieve the current object. When setting the router
                     retrieve the current object. When setting the router
@@ -325,7 +329,8 @@ Zend_Controller_Front::run('../application/controllers');
 
 
             <listitem>
             <listitem>
                 <para>
                 <para>
-                    <methodname>(set|get)BaseUrl()</methodname> let you specify <link
+                    <methodname>setBaseUrl()</methodname> and
+                    <methodname>getBaseUrl()</methodname> let you specify <link
                         linkend="zend.controller.request.http.baseurl">the base
                         linkend="zend.controller.request.http.baseurl">the base
                         URL</link> to strip when routing requests and to
                         URL</link> to strip when routing requests and to
                     retrieve the current value. The value is provided to the
                     retrieve the current value. The value is provided to the
@@ -335,7 +340,8 @@ Zend_Controller_Front::run('../application/controllers');
 
 
             <listitem>
             <listitem>
                 <para>
                 <para>
-                    <methodname>(set|get)Dispatcher()</methodname> let you specify <link
+                    <methodname>setDispatcher()</methodname> and
+                    <methodname>getDispatcher()</methodname> let you specify <link
                         linkend="zend.controller.dispatcher">the
                         linkend="zend.controller.dispatcher">the
                         dispatcher</link> class or object to use during the
                         dispatcher</link> class or object to use during the
                     dispatch process and retrieve the current object. When
                     dispatch process and retrieve the current object. When
@@ -353,7 +359,8 @@ Zend_Controller_Front::run('../application/controllers');
 
 
             <listitem>
             <listitem>
                 <para>
                 <para>
-                    <methodname>(set|get)Response()</methodname> let you specify <link
+                    <methodname>setResponse()</methodname> and
+                    <methodname>getResponse()</methodname> let you specify <link
                         linkend="zend.controller.response">the response</link>
                         linkend="zend.controller.response">the response</link>
                     class or object to use during the dispatch process and to
                     class or object to use during the dispatch process and to
                     retrieve the current object. When setting the response
                     retrieve the current object. When setting the response

+ 4 - 4
documentation/manual/en/module_specs/Zend_Controller-Migration.xml

@@ -277,13 +277,13 @@ $front->setParam('noViewRenderer', true);
 
 
         <itemizedlist>
         <itemizedlist>
             <listitem>
             <listitem>
-                <para>Calls to <methodname>$this->render()</methodname></para>
+                <para>Calls to <command>$this->render();</command></para>
             </listitem>
             </listitem>
             <listitem>
             <listitem>
-                <para>Calls to <methodname>$this->_forward()</methodname></para>
+                <para>Calls to <command>$this->_forward();</command></para>
             </listitem>
             </listitem>
             <listitem>
             <listitem>
-                <para>Calls to <methodname>$this->_redirect()</methodname></para>
+                <para>Calls to <command>$this->_redirect();</command></para>
             </listitem>
             </listitem>
             <listitem>
             <listitem>
                 <para>Calls to the <classname>Redirector</classname> action helper</para>
                 <para>Calls to the <classname>Redirector</classname> action helper</para>
@@ -339,7 +339,7 @@ public function preDispatch()
                     If you're calling <methodname>render()</methodname> with arguments, and
                     If you're calling <methodname>render()</methodname> with arguments, and
                     not doing any processing afterwards or rendering multiple
                     not doing any processing afterwards or rendering multiple
                     view scripts, you can change these calls to read
                     view scripts, you can change these calls to read
-                    <methodname>$this->_helper->viewRenderer()</methodname>.
+                    <command>$this->_helper->viewRenderer();</command>.
                 </para>
                 </para>
             </listitem>
             </listitem>
         </itemizedlist>
         </itemizedlist>