autodoc.git/ autodoc.xml

Branch: Tag:

2000-09-26

2000-09-26 00:17:48 by Fredrik Hübinette (Hubbe) <hubbe@hubbe.net>

#pike 7.0 should now work

Rev: lib/7.0/modules/Calendar.pmod/Austrian.pmod:1.1
Rev: lib/7.0/modules/Calendar.pmod/Gregorian.pmod:1.1
Rev: lib/7.0/modules/Calendar.pmod/ISO.pmod:1.1
Rev: lib/7.0/modules/Calendar.pmod/Julian.pmod:1.1
Rev: lib/7.0/modules/Calendar.pmod/Orthodox.pmod:1.1
Rev: lib/7.0/modules/Calendar.pmod/Stardate.pmod:1.1
Rev: lib/7.0/modules/Calendar.pmod/Swedish.pmod:1.1
Rev: lib/7.0/modules/Calendar.pmod/module.pmod:1.1
Rev: lib/7.0/modules/Stdio.pmod/module.pmod:1.1
Rev: src/builtin_functions.c:1.312
Rev: src/compilation.h:1.21
Rev: src/cpp.c:1.76
Rev: src/language.yacc:1.213
Rev: src/lexer.h:1.21
Rev: src/preprocessor.h:1.34
Rev: src/program.c:1.273
Rev: src/program.h:1.111
Rev: src/testsuite.in:1.333

1:   <?xml version='1.0' encoding='utf-8'?>   <autodoc> + <namespace name='7.0'> + <module name='Calendar'> + <doc> + <text> + <p> + This module implements calendar calculations, and base classes + for time units. + </p> + </text> +  + </doc> + <module name='Gregorian'> + <doc> + <text> + <p>time units: + <ref resolved='7.0::Calendar.Gregorian.Year'>Year</ref>, <ref>Month</ref>, <ref>Week</ref>, <ref>Day</ref> + </p> + </text> +  + </doc> + <docgroup homogen-name='datetime' homogen-type='method'> + <method name='datetime'> +  <returntype><mixed/></returntype> +  <arguments><argument name='unix_time'><type> +  <or><int/><void/></or></type></argument> +  +  </arguments> + </method><doc> + <text> + <p>Replacement for localtime. + </p> + </text> +  + </doc> + </docgroup> + <docgroup homogen-name='datetime_name' homogen-type='method'> + <method name='datetime_name'> +  <returntype><mixed/></returntype> +  <arguments><argument name='unix_time'><type> +  <or><int/><void/></or></type></argument> +  +  </arguments> + </method><doc> + <text> + <p>Replacement for ctime. + </p> + </text> +  + </doc> + </docgroup> + <docgroup homogen-name='datetime_short_name' homogen-type='method'> + <method name='datetime_short_name'> +  <returntype><mixed/></returntype> +  <arguments><argument name='unix_time'><type> +  <or><int/><void/></or></type></argument> +  +  </arguments> + </method><doc> + <text> + <p>Replacement for ctime. + </p> + </text> +  + </doc> + </docgroup> +  + <class name='Year'> + <doc> + <text> + <p>A <ref resolved='7.0::Calendar.time_unit'>Calendar.time_unit</ref>.</p> +  + <p>Lesser units: <ref>Month</ref>, <ref>Week</ref>, <ref>Day</ref> + Greater units: none</p> +  + <p/> + </text> +  + </doc> + <docgroup homogen-name='parse' homogen-type='method'> + <method name='parse'> +  <returntype> +  <object>object </object></returntype> +  <arguments><argument name='fmt'><type><string/></type></argument> + <argument name='arg'><type><string/></type></argument> +  +  </arguments> + </method><doc> + <text> + <p>parse a date, create relevant object + fmt is in the format "abc%xdef..." + where abc and def is matched, and %x is + one of those time units: + %Y absolute year + %y year (70-99 is 1970-1999, 0-69 is 2000-2069) + %M month (number, name or short name) (needs %y) + %W week (needs %y) + %D date (needs %y, %m) + %a day (needs %y) + %e weekday (needs %y, %w) + %h hour (needs %d, %D or %W) + %m minute (needs %h) + %s second (needs %s) + </p> + </text> +  + </doc> + </docgroup> + </class> + </module> + <module name='Stardate'> + <doc> + <text> + <p>time unit: TNGDate</p> + </text> +  + </doc> + <class name='TNGDate'> + <doc> + <text> + <p>implements ST:TNG stardates + can be used as create argument to Day</p> + </text> +  + </doc> + </class> + </module> + <class name='time_unit'> + <docgroup homogen-type='method'> + <method name='next'> +  <returntype> +  <object>object </object></returntype> +  <arguments> +  </arguments> + </method><method name='prev'> +  <returntype> +  <object>object </object></returntype> +  <arguments> +  </arguments> + </method><method name='`+'> +  <returntype> +  <object>object </object></returntype> +  <arguments><argument name='n'><type><int/></type></argument> +  +  </arguments> + </method><method name='`-'> +  <returntype> +  <object>object </object></returntype> +  <arguments><argument name='n'><type><int/></type></argument> +  +  </arguments> + </method><method name='`-'> +  <returntype> +  <object>object </object></returntype> +  <arguments><argument name='x'><type><object resolved='7.0::Calendar.time_unit.next'/></type></argument> +  +  </arguments> + </method><doc> + <text> + <p>next and prev gives the logical next and previous object. + The <tt>+</tt> operator gives that logical relative object, + ie <tt>my_day+14</tt> gives 14 days ahead. + <tt>-</tt> works the same way, but can also take an object + of the same type and give the difference as an integer.</p> + </text> +  + </doc> + </docgroup> + <docgroup homogen-name='greater' homogen-type='method'> + <method name='greater'> +  <returntype> +  <array><valuetype><string/></valuetype></array></returntype> +  <arguments> +  </arguments> + </method><doc> + <text> + <p>Gives a list of methods to get greater (longer) time units + from this object. For a month, this gives back <tt>({"year"})</tt>, + thus the method <tt>month-&gt;year()</tt> gives the year object. + </p> + </text> +  + </doc> + </docgroup> + <docgroup homogen-name='lesser' homogen-type='method'> + <method name='lesser'> +  <returntype> +  <array><valuetype><string/></valuetype></array></returntype> +  <arguments> +  </arguments> + </method><doc> + <text> + <p>Gives a list of methods to get lesser (shorter) time units. + ie, for a month, this gives back <tt>({"day"})</tt> + and the method <tt>day(mixed n)</tt> gives back that + day object. The method <tt>days()</tt> gives back a + list of possible argument values to the method <tt>day</tt>. + Concurrently, <tt>Array.map(o-&gt;days(),o-&gt;day)</tt> gives + a list of day objects in the object <tt>o</tt>.</p> +  + <p> + Ie:<pre> + array(string) lesser() - gives back a list of possible xxx's. + object xxxs() - gives back a list of possible n's. + object xxx(mixed n) - gives back xxx n + object xxx(object(Xxx) o) - gives back the corresponing xxx + </pre></p> +  + <p>The list of n's (as returned from xxxs) are always in order.</p> +  + <p>There are two n's with special meaning, 0 and -1. + 0 always gives the first xxx, equal to + my_obj-&gt;xxx(my_obj-&gt;xxxs()[0]), and -1 gives the last, + equal to my_obj-&gt;xxx(my_obj-&gt;xxxs()[-1]).</p> +  + <p>To get all xxxs in the object, do something like + <tt>Array.map(my_obj-&gt;xxxs(),my_obj-&gt;xxx)</tt>.</p> +  + <p>xxx(object) may return zero, if there was no correspondning xxx. + </p> + </text> +  + </doc> + </docgroup> + </class> + </module> + </namespace>   <namespace name='predef'>   <docgroup homogen-name='_do_call_outs' homogen-type='method'>   <method name='_do_call_outs'/><doc placeholder='true'>