Update of /cvsroot/phpweather/phpweather/doc In directory usw-pr-cvs1:/tmp/cvs-serv29390 Modified Files: class_locale_common.xml locale_common.html Log Message: Just some more documentation-fixes. Index: class_locale_common.xml =================================================================== RCS file: /cvsroot/phpweather/phpweather/doc/class_locale_common.xml,v retrieving revision 1.3 retrieving revision 1.4 diff -u -3 -r1.3 -r1.4 --- class_locale_common.xml 2001/03/26 19:31:37 1.3 +++ class_locale_common.xml 2001/03/26 20:13:23 1.4 @@ -1 +1 @@ -<?xml version="1.0"?><phpdoc><class name="locale_common" extends="base_object" undoc="false" access="private" package="PHP Weather"><file>/www/gimpster.com/php/phpweather/locale_common.php</file><doc><author email="[EMAIL PROTECTED]">Martin Geisler</author><inherited src="Array"/><description>This class has the capability to do an English pretty-print, if it is provided with the right set of strings. It&apos;s up to child-classes to provide these strings, and override the methods in this class, as necessary.</description><shortdescription>Provides all the function needed to generate (English) output.</shortdescription><version>$Id$</version></doc><function name="locale_common" undoc="false" access="public"><doc><parameter name="$input" type="array">initial properties of the object.</parameter><return type="void"/><description>The defaults are extended with- &apos;pref_units&apos; = &apos;both_metric&apos;- &apos;mark_begin&apos; = &apos;&lt;b&gt;&apos;- &apos;mark_end&apos; = &apos;&lt;/b&gt;&apos;- &apos;exclude&apos; = array()</description><shortdescription>Sets up the defaults.</shortdescription></doc></function><function name="set_marks" undoc="false" access="public"><doc><see type="function">get_marks()</see><parameter name="$new_mark_begin" type="string">mark used before numbers, for example &apos;&lt;font color=&quot;red&quot;&gt;&apos;</parameter><parameter name="$new_mark_end" type="string">mark used after numbers, for example &apos;&lt;/font&gt;&apos;</parameter><return type="void"/><description/><shortdescription>Sets the marks (the strings inserted before and after every number)</shortdescription></doc></function><function name="get_marks" undoc="false" access="public"><doc><see type="function">set_marks()</see><return name="" type="array">The first element is used before any number, and the second element is used after.</return><description/><shortdescription>Gets the marks</shortdescription></doc></function><function name="set_pref_units" undoc="false" access="public"><doc><see type="function">get_pref_units()</see><parameter name="$new_pref_units" type="string">new kind of units one wants to use.</parameter><return type="void"/><description>$new_pref_units can be one of the following strings:- &apos;both_metric&apos; if one wants to produce output like this &apos;10 kilometers (16.1 miles)&apos;- &apos;both_imperial&apos; if one wants to produce output like this &apos;16.1 miles (10 kilometers)&apos;- &apos;only_metric&apos; if one wants to produce output like this &apos;10 kilometers&apos;- &apos;only_imperial&apos; if one wants to produce output like this &apos;16.1 miles&apos;</description><shortdescription>Specifies which kind of units to display.</shortdescription></doc></function><function name="get_pref_units" undoc="false" access="public"><doc><see type="function">set_pref_units()</see><return name="" type="string">The preferred kind of units.</return><description/><shortdescription>Gets the preferred units.</shortdescription></doc></function><function name="set_exclude" undoc="false" access="public"><doc><see type="function">get_exclude()</see><parameter name="$new_exclude" type="array">array should contain the names of the sections one doesn&apos;t want to have displayed, like &apos;wind&apos; or &apos;time&apos; if one wants to skip the wind or time-parts of the pretty-print.</parameter><return type="void"/><description/><shortdescription>Used to specify which elements one wants to exclude from the pretty-print.</shortdescription></doc></function><function name="get_exclude" undoc="false" access="public"><doc><see type="function">set_exclude()</see><return name="" type="array">The excluded elements.</return><description/><shortdescription>Gets the array of excluded elements of the pretty-print.</shortdescription></doc></function><function name="pref_units" undoc="false" access="private"><doc><see type="function">set_pref_units()</see><parameter name="$str1" type="string">string should always contain the metric value.</parameter><parameter name="$str2" type="string">string should always contain the imperial value.</parameter><return name="" type="string">The two arguments in the correct order with regard to the preferred units.</return><description/><shortdescription>Used to format strings with regard to the preferred units.</shortdescription></doc></function><function name="list_sentences" undoc="false" access="private"><doc><return name="" type="string">The arguments put together.</return><description>Takes an arbitrary number of strings as its arguments, and returns them with commas between. The strings used between the arguments, are controlled by these variables:- $strings[&apos;list_sentences_and&apos;]- $strings[&apos;list_sentences_comma&apos;]- $strings[&apos;list_sentences_final_and&apos;]Only non-empty arguments are used, so it&apos;s safe to call this function with empty strings.</description><shortdescription>Builds sentences from smaller bits.</shortdescription></doc></function><function name="parse_precip" undoc="false" access="private"><doc><parameter name="$in" type="integer">amount of precipitation measured in inches.</parameter><parameter name="$mm" type="integer">amount of precipitation measured in millimeter&apos;s.</parameter><return name="" type="string">A formatted string with information about the precipitation.</return><description/><shortdescription>Used to parse precipitation.</shortdescription></doc></function><function name="parse_cloud_group" undoc="false" access="private"><doc><parameter name="$cloud_group" type="array">cloud-group to be parsed.</parameter><return name="" type="string">the string used in the pretty-print.</return><description/><shortdescription>Function used to parse a cloud-group.</shortdescription></doc></function><function name="parse_weather_group" undoc="false" access="private"><doc><parameter name="$weather_group" type="array">weather-group to be parsed.</parameter><return name="" type="string">the string used in the pretty-print.</return><description/><shortdescription>Function used to parse a weather-group.</shortdescription></doc></function><function name="runway_tendency" undoc="false" access="private"><doc><parameter name="$tendency" type="string">tendency</parameter><return name="" type="string">the string used in the pretty-print.</return><description/><shortdescription>Function used to parse the tendency in a runway-group.</shortdescription></doc></function><function name="parse_runway_group" undoc="false" access="private"><doc><parameter name="$runway_group" type="array">runway-group to be parsed.</parameter><return name="" type="string">the string used in the pretty-print.</return><description/><shortdescription>Function used to parse a runway-group.</shortdescription></doc></function><function name="parse_visibility_group" undoc="false" access="private"><doc><parameter name="$visibility_group" type="array">visibility-group to be parsed.</parameter><return name="" type="string">the string used in the pretty-print.</return><description/><shortdescription>Function used to parse a visibility-group.</shortdescription></doc></function><function name="print_pretty" undoc="false" access="public"><doc><parameter name="$data" type="array">taken from decode_metar()</parameter><return name="" type="string">The pretty-printed output.</return><description>This is the function responsible for making the weather-report, also know as the &apos;pretty-print&apos;.</description><shortdescription>The pretty-print function.</shortdescription></doc></function><function name="print_table" undoc="false" access="public"><doc><parameter name="$data" type="array">taken from decode_metar()</parameter><return name="" type="string">The table with weather-data.</return><description/><shortdescription>Makes a short weather-report in a table.</shortdescription></doc></function><variable name="$strings" access="private" type="array">a rray()<doc><description>Each string is identified by it&apos;s key in the array. Some strings are used between the dynamic parts, and others are used as format-strings to sprintf().</description><shortdescription>The strings used in the translation is stored here.</shortdescription></doc></variable><inherited src="base_object" type="functions"><element>base_object</element><element>error</element><element>notice</element><element>print_properties</element></inherited><inherited src="base_object" type="variables"><element>$properties</element><element>$defaults</element></inherited><path><parent>base_object</parent></path><baseclass>base_object</baseclass><subclasses><subclass>locale_en</subclass></subclasses></class></phpdoc> \ No newline at end of file +<?xml version="1.0"?><phpdoc><class name="locale_common" extends="base_object" +undoc="false" access="private" package="PHP +Weather"><file>/www/gimpster.com/php/phpweather/locale_common.php</file><doc><author +email="[EMAIL PROTECTED]">Martin Geisler</author><inherited +src="Array"/><description>This class has the capability to do an English +pretty-print, if it is provided with the right set of strings. It&apos;s up to +child-classes to provide these strings, and override the methods in this class, as +necessary.</description><shortdescription>Provides all the function needed to +generate (English) output.</shortdescription><version>$Id$</version></doc><function +name="locale_common" undoc="false" access="public"><doc><parameter name="$input" +type="array">initial properties of the object. If you omit some properties, the +defaults should kick-in.</parameter><return type="void"/><description>The defaults +are extended with- &apos;pref_units&apos; = &apos;both_metric&apos;- +&apos;mark_begin&apos; = &apos;&lt;b&gt;&apos;- +&apos;mark_end&apos; = &apos;&lt;/b&gt;&apos;- +&apos;exclude&apos; = array()</description><shortdescription>Sets up the +defaults.</shortdescription></doc></function><function name="set_marks" undoc="false" +access="public"><doc><see type="function">get_marks()</see><parameter +name="$new_mark_begin" type="string">mark used before numbers and other data +elements, for example &apos;&lt;font +color=&quot;red&quot;&gt;&apos;</parameter><parameter +name="$new_mark_end" type="string">mark used after numbers and other data elements, +for example &apos;&lt;/font&gt;&apos;. If you use HTML tags, +it&apos;s your responsibility to ensure that they match up.</parameter><return +type="void"/><description/><shortdescription>Sets the marks (the strings inserted +before and after every number)</shortdescription></doc></function><function +name="get_marks" undoc="false" access="public"><doc><see +type="function">set_marks()</see><return name="" type="array">The first element is +the string inserted before any number, and the second element is the string inserted +after.</return><description/><shortdescription>Gets the +marks</shortdescription></doc></function><function name="set_pref_units" +undoc="false" access="public"><doc><see +type="function">get_pref_units()</see><parameter name="$new_pref_units" +type="string">new kind of units one wants to use.</parameter><return +type="void"/><description>$new_pref_units can be one of the following strings:- +&apos;both_metric&apos; if one wants to produce output like this &apos;10 +kilometers (16.1 miles)&apos;- &apos;both_imperial&apos; if one wants to +produce output like this &apos;16.1 miles (10 kilometers)&apos;- +&apos;only_metric&apos; if one wants to produce output like this &apos;10 +kilometers&apos;- &apos;only_imperial&apos; if one wants to produce +output like this &apos;16.1 +miles&apos;</description><shortdescription>Specifies which kind of units to +display.</shortdescription></doc></function><function name="get_pref_units" +undoc="false" access="public"><doc><see type="function">set_pref_units()</see><return +name="" type="string">The preferred kind of units. This will be one of +&apos;both_metric&apos;, &apos;both_imperial&apos;, +&apos;only_metric&apos; or +&apos;only_imperial&apos;.</return><description/><shortdescription>Gets the +preferred units.</shortdescription></doc></function><function name="set_exclude" +undoc="false" access="public"><doc><see type="function">get_exclude()</see><parameter +name="$new_exclude" type="array">array should contain the names of the sections one +doesn&apos;t want to have displayed, like &apos;wind&apos; or +&apos;time&apos; if one wants to skip the wind or time parts of the +pretty-print.</parameter><return type="void"/><description/><shortdescription>Used to +specify which elements one wants to exclude from the +pretty-print.</shortdescription></doc></function><function name="get_exclude" +undoc="false" access="public"><doc><see type="function">set_exclude()</see><return +name="" type="array">The excluded +elements.</return><description/><shortdescription>Gets the array of excluded elements +of the pretty-print.</shortdescription></doc></function><function name="pref_units" +undoc="false" access="private"><doc><see +type="function">set_pref_units()</see><parameter name="$str1" type="string">string +should always contain the metric value.</parameter><parameter name="$str2" +type="string">string should always contain the imperial value.</parameter><return +name="" type="string">The two arguments in the correct order with regard to the +preferred units.</return><description/><shortdescription>Used to format strings with +regard to the preferred units.</shortdescription></doc></function><function +name="list_sentences" undoc="false" access="private"><doc><return name="" +type="string">The arguments put together.</return><description>Takes an arbitrary +number of strings as its arguments, and returns them with commas between. The strings +used between the arguments, are controlled by these variables:- +$strings[&apos;list_sentences_and&apos;]- +$strings[&apos;list_sentences_comma&apos;]- +$strings[&apos;list_sentences_final_and&apos;]Only non-empty arguments are +used, so it&apos;s safe to call this function with empty +strings.</description><shortdescription>Builds sentences from smaller +bits.</shortdescription></doc></function><function name="parse_precip" undoc="false" +access="private"><doc><parameter name="$in" type="integer">amount of precipitation +measured in inches.</parameter><parameter name="$mm" type="integer">amount of +precipitation measured in millimeters.</parameter><return name="" type="string">A +formatted string with information about the +precipitation.</return><description/><shortdescription>Used to parse +precipitation.</shortdescription></doc></function><function name="parse_cloud_group" +undoc="false" access="private"><doc><parameter name="$cloud_group" +type="array">cloud-group to be parsed.</parameter><return name="" type="string">the +string used in the pretty-print.</return><description/><shortdescription>Function +used to parse a cloud-group.</shortdescription></doc></function><function +name="parse_weather_group" undoc="false" access="private"><doc><parameter +name="$weather_group" type="array">weather-group to be parsed.</parameter><return +name="" type="string">the string used in the +pretty-print.</return><description/><shortdescription>Function used to parse a +weather-group.</shortdescription></doc></function><function name="runway_tendency" +undoc="false" access="private"><doc><parameter name="$tendency" +type="string">tendency</parameter><return name="" type="string">the string used in +the pretty-print.</return><description/><shortdescription>Function used to parse the +tendency in a runway-group.</shortdescription></doc></function><function +name="parse_runway_group" undoc="false" access="private"><doc><parameter +name="$runway_group" type="array">runway-group to be parsed.</parameter><return +name="" type="string">the string used in the +pretty-print.</return><description/><shortdescription>Function used to parse a +runway-group.</shortdescription></doc></function><function +name="parse_visibility_group" undoc="false" access="private"><doc><parameter +name="$visibility_group" type="array">visibility-group to be +parsed.</parameter><return name="" type="string">the string used in the +pretty-print.</return><description/><shortdescription>Function used to parse a +visibility-group.</shortdescription></doc></function><function name="print_pretty" +undoc="false" access="public"><doc><parameter name="$data" type="array">taken from +decode_metar()</parameter><return name="" type="string">The pretty-printed +output.</return><description>This is the function responsible for making the +weather-report, also know as the +&apos;pretty-print&apos;.</description><shortdescription>The pretty-print +function.</shortdescription></doc></function ><function name="print_table" undoc="false" access="public"><doc><parameter >name="$data" type="array">taken from decode_metar()</parameter><return name="" >type="string">The table with >weather-data.</return><description/><shortdescription>Makes a short weather-report in >a table.</shortdescription></doc></function><variable name="$strings" >access="private" type="array">array()<doc><description>Each string is identified by >it&apos;s key in the array. Some strings are used between the dynamic parts, and >others are used as format-strings to sprintf().</description><shortdescription>The >strings used in the translation is stored >here.</shortdescription></doc></variable><inherited src="base_object" >type="functions"><element>base_object</element><element>error</element><element>notice</element><element>print_properties</element></inherited><inherited > src="base_object" >type="variables"><element>$properties</element><element>$defaults</element></inherited><path><parent>base_object</parent></path><baseclass>base_object</baseclass><subclasses><subclass>locale_en</subclass></subclasses></class></phpdoc> \ No newline at end of file Index: locale_common.html =================================================================== RCS file: /cvsroot/phpweather/phpweather/doc/locale_common.html,v retrieving revision 1.3 retrieving revision 1.4 diff -u -3 -r1.3 -r1.4 --- locale_common.html 2001/03/26 19:31:37 1.3 +++ locale_common.html 2001/03/26 20:13:23 1.4 @@ -266,7 +266,7 @@ </tr> <tr> <td></td> - <td colspan="2" align="left" valign="top">initial properties of the object.</td> + <td colspan="2" +align="left" valign="top">initial properties of the object. If you omit some +properties, the defaults should kick-in.</td> </tr> </table> </td> @@ -326,7 +326,7 @@ </tr> <tr> <td></td> - <td colspan="2" align="left" valign="top">mark used before numbers, for example '<font color="red">'</td> + <td colspan="2" +align="left" valign="top">mark used before numbers and other data elements, for +example '<font color="red">'</td> </tr> </table> </td> @@ -343,7 +343,7 @@ </tr> <tr> <td></td> - <td colspan="2" align="left" valign="top">mark used after numbers, for example '</font>'</td> + <td colspan="2" +align="left" valign="top">mark used after numbers and other data elements, for +example '</font>'. If you use HTML tags, it's your responsibility to ensure +that they match up.</td> </tr> </table> </td> @@ -396,7 +396,7 @@ <tr> <td align="left" valign="top">Returns</td> - <td>array <p>The first element is used before any number, and the second element is used after.</td> + <td>array <p>The first element is the string +inserted before any number, and the second element is the string inserted after.</td> </tr> @@ -504,7 +504,7 @@ <tr> <td align="left" valign="top">Returns</td> - <td>string <p>The preferred kind of units.</td> + <td>string <p>The preferred kind of units. +This will be one of 'both_metric', 'both_imperial', 'only_metric' or +'only_imperial'.</td> </tr> @@ -559,7 +559,7 @@ </tr> <tr> <td></td> - <td colspan="2" align="left" valign="top">array should contain the names of the sections one doesn't want to have displayed, like 'wind' or 'time' if one wants to skip the wind or time-parts of the pretty-print.</td> + <td colspan="2" +align="left" valign="top">array should contain the names of the sections one doesn't +want to have displayed, like 'wind' or 'time' if one wants to skip the wind or time +parts of the pretty-print.</td> </tr> </table> </td> @@ -934,7 +934,7 @@ </tr> <tr> <td></td> - <td colspan="2" align="left" valign="top">amount of precipitation measured in millimeter's.</td> + <td colspan="2" +align="left" valign="top">amount of precipitation measured in millimeters.</td> </tr> </table> </td> _______________________________________________ PHPWeather-checkins mailing list [EMAIL PROTECTED] http://lists.sourceforge.net/lists/listinfo/phpweather-checkins