autodoc.git/ autodoc.xml

2000-09-30

2000-09-30 09:49:53 by Mirar (Pontus Hagland) <pike@sort.mirar.org>

• 26f9ac8750af1b1a9649e09ac5e9e1a36e0872fd (101 lines) (+3/-98) ^{[ Show | Annotate ]}
  Branch: 8.0
  Tags: v7.1.11 and v7.1.10

namedays handled in new format (no lookup yet though)

Rev: lib/modules/Calendar.pmod/Event.pmod:1.9
Rev: lib/modules/Calendar.pmod/Events.pmod:1.6
Rev: lib/modules/Calendar.pmod/events/namedays:1.2
Rev: lib/modules/Calendar.pmod/events/regional:1.7

1745:    This is created by the <ref>Namedays</ref> classes    to represent an event for a name.   subclass Namedays -  This contains a ruleset about namedays. It -  is a virtual base class. +  This contains a ruleset about namedays.   subclass Date    This class represents the event of a given gregorian date.    For instance,
1903:   <docgroup homogen-name='Event' homogen-type='inherit'>   <inherit name='Event'><classname resolved='predef::Calendar.Event'>Event</classname></inherit>   </docgroup> - <docgroup homogen-name='make_lookup' homogen-type='method'> - <method name='make_lookup'> -  <returntype> -  <object>mapping </object></returntype> -  <arguments><argument name='names'><type> -  <array><valuetype><string/></valuetype></array></type></argument> -  -  </arguments> - </method><doc> - <text> - <p>Help function to make a lookup mapping - of the names feeded to it.</p> - </text> - <group><note/><text> - <p>This function is <tt>static</tt>.</p> - </text></group> -  - </doc> - </docgroup> - <docgroup homogen-name='nameday_lookup' homogen-type='method'> - <method name='nameday_lookup'> -  <returntype> -  <object>int </object></returntype> -  <arguments><argument name='y'><type><int/></type></argument> - <argument name='name'><type><string/></type></argument> -  -  </arguments> - </method><doc> - <text> - <p>Static virtual function that gives back the - day (1..) of the year for the given name - - if the year is a non-leap year (!), -1 - if the name is on the leap day, or zero if - the name doesn't exist that year.</p> - </text> -  - </doc> - </docgroup> +    <docgroup homogen-name='namedays' homogen-type='method'>   <method name='namedays'>    <returntype>
1961:      </doc>   </docgroup> - <docgroup homogen-name='namedays_year' homogen-type='method'> - <method name='namedays_year'> -  <returntype> -  <array><valuetype><string/></valuetype></array></returntype> -  <arguments><argument name='y'><type><int/></type></argument> -  -  </arguments> - </method><doc> - <text> - <p>Static virtual function that should give back the array - of namedays that year, or zero if there - are no named days for that year.</p> -  - <p>The array is arranged as day 1..365 - a non-leap year, followed by the leap day. - If a day doesn't contain names, it should be zero, - not a string. If a day has more then one name, - it should be separated by a comma (in the string!).</p> - </text> -  - </doc> - </docgroup> +    <docgroup homogen-name='names' homogen-type='method'>   <method name='names'>    <returntype>
2050:    <or><void/><int><min>0</min><max>1</max></int></or></type></argument>       </arguments> - </method><doc> - <text> - <p>known bugs: -  Just returns the argument converted to a day.</p> - </text> -  - </doc> - </docgroup> + </method></docgroup>   <docgroup homogen-type='method'>   <method name='scan'>    <returntype>
2094:      </doc>   </docgroup> - <docgroup homogen-type='method'> - <method name='next_name'> -  <returntype> -  <object resolved='predef::Calendar.TimeRange'>TimeRange </object></returntype> -  <arguments><argument name='from'><type> -  <object resolved='predef::Calendar.TimeRange'>TimeRange</object></type></argument> - <argument name='name'><type><string/></type></argument> - <argument name='inclusive'><type><int/></type></argument> -  -  </arguments> - </method><method name='previous_name'> -  <returntype> -  <object resolved='predef::Calendar.TimeRange'>TimeRange </object></returntype> -  <arguments><argument name='from'><type> -  <object resolved='predef::Calendar.TimeRange'>TimeRange</object></type></argument> - <argument name='name'><type><string/></type></argument> - <argument name='inclusive'><type><int/></type></argument> -  -  </arguments> - </method><doc> - <text> - <p>Gives back the next or previous day where the name - occurs, inclusive the start of the given timerange if - that flag is non-zero.</p> - </text> -  - </doc> - </docgroup> +    <docgroup homogen-name='scan_jd' homogen-type='method'>   <method name='scan_jd'>    <returntype>