autodoc.git/ autodoc.xml

Branch: Tag:

2000-08-11

2000-08-11 08:48:39 by Mirar (Pontus Hagland) <pike@sort.mirar.org>

docfix

Rev: lib/modules/Calendar.pmod/Event.pmod:1.4
Rev: lib/modules/Calendar.pmod/TZnames.pmod:1.3
Rev: lib/modules/Calendar.pmod/YMD.pmod:1.7

1570:   <method name='create'>    <returntype>    <object>void </object></returntype> -  <arguments><argument name='month_day'><type><int/></type></argument> - <argument name='weekday'><type><int/></type></argument> +  <arguments><argument name='weekday'><type><int/></type></argument>       </arguments>   </method><doc>   <text> - <p>The event is created by a given month day, - and a weekday number (1=Monday, 7=Sunday). + <p>The event is created by a given + weekday number (1=Monday, 7=Sunday).   </p>   </text>   <group><note/><text>
2149:   <p>The Posix and standard timezones (like CET, PST8PDT, etc)   are not listed.</p>   </text> - <group><note/><text> - <p>Loading all the timezones can take some time, since - they are generated and compiled on the fly. - Just because it's noted "CST" doesn't mean it's a - unique timezone. There is about 7 *different* timezones that - uses "CST" as abbreviation; not at the same time, - though, so the DWIM routines checks this before - it's satisfied. Same with some other timezones.</p> +     - <p>For most timezones, there is a number of region timezones that for the - given time are equal. This is because region timezones include rules - about local summer time shifts and possible historic shifts.</p> - </text></group> +           -  +    </doc>   <docgroup homogen-name='abbr2zones' homogen-type='constant'>   <constant name='abbr2zones'><typevalue>
2182:   ([ "CET": ({ "Europe/Stockholm", &lt;i&gt;[...]&lt;/i&gt; }),    "CST": ({ "America/Chicago", "Australia/Adelaide", &lt;i&gt;[...]&lt;/i&gt; }),    &lt;i&gt;[...]&lt;/i&gt; }), - </pre> - </p> + </pre></p> +  + <p>Note this: Just because it's noted "CST" doesn't mean it's a + unique timezone. There is about 7 *different* timezones that + uses "CST" as abbreviation; not at the same time, + though, so the DWIM routines checks this before + it's satisfied. Same with some other timezones.</p> +  + <p>For most timezones, there is a number of region timezones that for the + given time are equal. This is because region timezones include rules + about local summer time shifts and possible historic shifts.</p> +  + <p>The <ref>YMD.parse</ref> functions can handle timezone abbreviations + by guessing.</p>   </text>      </doc>
2204:   ([ "America": ({ "Los_Angeles", "Chicago", &lt;i&gt;[...]&lt;/i&gt; }),    "Europe": ({ "Stockholm", &lt;i&gt;[...]&lt;/i&gt; }),    &lt;i&gt;[...]&lt;/i&gt; }), - </pre> - </p> + </pre></p> +  + <p>Please note that loading all the timezones can take some + time, since they are generated and compiled on the fly.</p>   </text>      </doc>
4214:   WST Australia/Perth [UTC+8]   </pre></p>    - <p>This mapping is modifiable in the ruleset, - see <ref>Ruleset.set_abbr2zone</ref>.</p> + <p>This mapping is modifiable in the ruleset, see + <ref>Ruleset.set_abbr2zone</ref>.</p>   </text></group>      </doc>