gregorian_autodoc.boostbook

C++的一个好库。。。现在很流行

<?xml version="1.0" standalone="yes"?>
<!-- Copyright (c) 2001-2005 CrystalClear Software, Inc.
     Subject to the Boost Software License, Version 1.0. 
     (See accompanying file LICENSE-1.0 or  http://www.boost.org/LICENSE-1.0)
-->
<!-- date source directory processed: 2005-Jun-27 -->
<section id="gregorian_reference">
<title>Gregorian Reference</title>
  <header name="boost/date_time/gregorian/conversion.hpp">
    <namespace name="boost">
      <namespace name="gregorian">
        <function name="to_tm">
          <type>tm</type>
          <parameter name="d">
            <paramtype>const <classname>date</classname> &amp;</paramtype>
          </parameter>
          <purpose>Converts a date to a tm struct. Throws out_of_range exception if date is a special value. </purpose>
        </function>
        <function name="date_from_tm">
          <type>
            <classname>date</classname>
          </type>
          <parameter name="datetm">
            <paramtype>const tm &amp;</paramtype>
          </parameter>
          <purpose>Converts a tm structure into a date dropping the any time values. </purpose>
        </function>
      </namespace>
    </namespace>
  </header>
  <header name="boost/date_time/gregorian/formatters.hpp">
    <namespace name="boost">
      <namespace name="gregorian">
        <function name="to_simple_string_type">
          <type>std::basic_string&lt; charT &gt;</type>
          <template>
          <template-type-parameter name="charT"/>
        </template>
          <parameter name="d">
            <paramtype>const <classname>date</classname> &amp;</paramtype>
          </parameter>
        </function>
        <function name="to_simple_string">
          <type>std::string</type>
          <parameter name="d">
            <paramtype>const <classname>date</classname> &amp;</paramtype>
          </parameter>
          <purpose>To YYYY-mmm-DD string where mmm 3 char month name. Example: 2002-Jan-01. </purpose>
        </function>
        <function name="to_simple_string_type">
          <type>std::basic_string&lt; charT &gt;</type>
          <template>
          <template-type-parameter name="charT"/>
        </template>
          <parameter name="d">
            <paramtype>const date_period &amp;</paramtype>
          </parameter>
        </function>
        <function name="to_simple_string">
          <type>std::string</type>
          <parameter name="d">
            <paramtype>const date_period &amp;</paramtype>
          </parameter>
          <purpose>Convert date period to simple string. Example: [2002-Jan-01/2002-Jan-02]. </purpose>
        </function>
        <function name="to_iso_string_type">
          <type>std::basic_string&lt; charT &gt;</type>
          <template>
          <template-type-parameter name="charT"/>
        </template>
          <parameter name="d">
            <paramtype>const date_period &amp;</paramtype>
          </parameter>
        </function>
        <function name="to_iso_string">
          <type>std::string</type>
          <parameter name="d">
            <paramtype>const date_period &amp;</paramtype>
          </parameter>
          <purpose>Date period to iso standard format CCYYMMDD/CCYYMMDD. Example: 20021225/20021231. </purpose>
        </function>
        <function name="to_iso_extended_string_type">
          <type>std::basic_string&lt; charT &gt;</type>
          <template>
          <template-type-parameter name="charT"/>
        </template>
          <parameter name="d">
            <paramtype>const <classname>date</classname> &amp;</paramtype>
          </parameter>
        </function>
        <function name="to_iso_extended_string">
          <type>std::string</type>
          <parameter name="d">
            <paramtype>const <classname>date</classname> &amp;</paramtype>
          </parameter>
          <purpose>Convert to iso extended format string CCYY-MM-DD. Example 2002-12-31. </purpose>
        </function>
        <function name="to_iso_string_type">
          <type>std::basic_string&lt; charT &gt;</type>
          <template>
          <template-type-parameter name="charT"/>
        </template>
          <parameter name="d">
            <paramtype>const <classname>date</classname> &amp;</paramtype>
          </parameter>
        </function>
        <function name="to_iso_string">
          <type>std::string</type>
          <parameter name="d">
            <paramtype>const <classname>date</classname> &amp;</paramtype>
          </parameter>
          <purpose>Convert to iso standard string YYYYMMDD. Example: 20021231. </purpose>
        </function>
        <function name="to_sql_string_type">
          <type>std::basic_string&lt; charT &gt;</type>
          <template>
          <template-type-parameter name="charT"/>
        </template>
          <parameter name="d">
            <paramtype>const <classname>date</classname> &amp;</paramtype>
          </parameter>
        </function>
        <function name="to_sql_string">
          <type>std::string</type>
          <parameter name="d">
            <paramtype>const <classname>date</classname> &amp;</paramtype>
          </parameter>
        </function>
        <function name="to_simple_wstring">
          <type>std::wstring</type>
          <parameter name="d">
            <paramtype>const date_period &amp;</paramtype>
          </parameter>
          <purpose>Convert date period to simple string. Example: [2002-Jan-01/2002-Jan-02]. </purpose>
        </function>
        <function name="to_simple_wstring">
          <type>std::wstring</type>
          <parameter name="d">
            <paramtype>const <classname>date</classname> &amp;</paramtype>
          </parameter>
          <purpose>To YYYY-mmm-DD string where mmm 3 char month name. Example: 2002-Jan-01. </purpose>
        </function>
        <function name="to_iso_wstring">
          <type>std::wstring</type>
          <parameter name="d">
            <paramtype>const date_period &amp;</paramtype>
          </parameter>
          <purpose>Date period to iso standard format CCYYMMDD/CCYYMMDD. Example: 20021225/20021231. </purpose>
        </function>
        <function name="to_iso_extended_wstring">
          <type>std::wstring</type>
          <parameter name="d">
            <paramtype>const <classname>date</classname> &amp;</paramtype>
          </parameter>
          <purpose>Convert to iso extended format string CCYY-MM-DD. Example 2002-12-31. </purpose>
        </function>
        <function name="to_iso_wstring">
          <type>std::wstring</type>
          <parameter name="d">
            <paramtype>const <classname>date</classname> &amp;</paramtype>
          </parameter>
          <purpose>Convert to iso standard string YYYYMMDD. Example: 20021231. </purpose>
        </function>
        <function name="to_sql_wstring">
          <type>std::wstring</type>
          <parameter name="d">
            <paramtype>const <classname>date</classname> &amp;</paramtype>
          </parameter>
        </function>
      </namespace>
    </namespace>
  </header>
  <header name="boost/date_time/gregorian/formatters_limited.hpp">
    <namespace name="boost">
      <namespace name="gregorian"/>
    </namespace>
  </header>
  <header name="boost/date_time/gregorian/greg_calendar.hpp">
    <namespace name="boost">
      <namespace name="gregorian">
        <class name="gregorian_calendar">
          <purpose>Gregorian calendar for this implementation, hard work in the base. </purpose>
          <typedef name="day_of_week_type">
            <purpose>Type to hold a weekday (eg: Sunday, Monday,...). </purpose>
            <type>
              <classname>greg_weekday</classname>
            </type>
          </typedef>
          <typedef name="day_of_year_type">
            <purpose>Counter type from 1 to 366 for gregorian dates. </purpose>
            <type>greg_day_of_year_rep</type>
          </typedef>
          <typedef name="date_rep_type">
            <purpose>Internal date representation that handles infinity, not a date. </purpose>
            <type>fancy_date_rep</type>
          </typedef>
          <typedef name="date_traits_type">
            <purpose>Date rep implements the traits stuff as well. </purpose>
            <type>fancy_date_rep</type>
          </typedef>
        </class>
        <typedef name="fancy_date_rep">
          <purpose>An internal date representation that includes infinities, not a date. </purpose>
          <type>date_time::int_adapter&lt; unsigned long &gt;</type>
        </typedef>
      </namespace>
    </namespace>
  </header>
  <header name="boost/date_time/gregorian/greg_date.hpp">
    <namespace name="boost">
      <namespace name="gregorian">
        <class name="date">
          <purpose>A date type based on gregorian_calendar. </purpose>
          <description>
            <para>This class is the primary interface for programming with greogorian dates. The is a lightweight type that can be freely passed by value. All comparison operators are supported. </para>
          </description>
          <typedef name="year_type">
            <type>gregorian_calendar::year_type</type>
          </typedef>
          <typedef name="month_type">
            <type>gregorian_calendar::month_type</type>
          </typedef>
          <typedef name="day_type">
            <type>gregorian_calendar::day_type</type>
          </typedef>
          <typedef name="day_of_year_type">
            <type>gregorian_calendar::day_of_year_type</type>
          </typedef>
          <typedef name="ymd_type">
            <type>gregorian_calendar::ymd_type</type>
          </typedef>
          <typedef name="date_rep_type">
            <type>gregorian_calendar::date_rep_type</type>
          </typedef>
          <typedef name="date_int_type">
            <type>gregorian_calendar::date_int_type</type>
          </typedef>
          <typedef name="duration_type">
            <type>date_duration</type>
          </typedef>
          <method-group name="public member functions">
            <method name="julian_day" cv="const">
              <type>date_int_type</type>
              <purpose>Return the Julian Day number for the date. </purpose>
            </method>
            <method name="day_of_year" cv="const">
              <type>day_of_year_type</type>
              <purpose>Return the day of year 1..365 or 1..366 (for leap year). </purpose>
            </method>
            <method name="modjulian_day" cv="const">
              <type>long</type>
              <purpose>Return the Modified Julian Day number for the date. </purpose>
            </method>
            <method name="week_number" cv="const">
              <type>int</type>
              <purpose>Return the iso 8601 week number 1..53. </purpose>
            </method>
            <method name="day_number" cv="const">
              <type>date_int_type</type>
              <purpose>Return the day number from the calendar. </purpose>
            </method>
            <method name="end_of_month" cv="const">
              <type>
                <classname>date</classname>
              </type>
              <purpose>Return the last day of the current month. </purpose>
            </method>
          </method-group>
          <constructor>
            <purpose>Default constructor constructs with not_a_date_time. </purpose>
          </constructor>
          <constructor>
            <parameter name="y">
              <paramtype>year_type</paramtype>
            </parameter>
            <parameter name="m">
              <paramtype>month_type</paramtype>
            </parameter>
            <parameter name="d">
              <paramtype>day_type</paramtype>
            </parameter>
            <purpose>Main constructor with year, month, day. </purpose>
          </constructor>
          <constructor>
            <parameter name="ymd">
              <paramtype>const ymd_type &amp;</paramtype>
            </parameter>
            <purpose>Constructor from a ymd_type structure. </purpose>
          </constructor>