date_time_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-Jul-24 -->
<section id="date_time_reference">
<title>Date Time Reference</title>
  <header name="boost/date_time/adjust_functors.hpp">
    <namespace name="boost">
      <namespace name="date_time">
        <class name="day_functor">
          <template>
      <template-type-parameter name="date_type"/>
    </template>
          <purpose>Functor to iterate a fixed number of days. </purpose>
          <typedef name="duration_type">
            <type>date_type::duration_type</type>
          </typedef>
          <method-group name="public member functions">
            <method name="get_offset" cv="const">
              <type>duration_type</type>
              <parameter name="d">
                <paramtype>const date_type &amp;</paramtype>
              </parameter>
            </method>
            <method name="get_neg_offset" cv="const">
              <type>duration_type</type>
              <parameter name="d">
                <paramtype>const date_type &amp;</paramtype>
              </parameter>
            </method>
          </method-group>
          <constructor>
            <parameter name="f">
              <paramtype>int</paramtype>
            </parameter>
          </constructor>
        </class>
        <class name="month_functor">
          <template>
      <template-type-parameter name="date_type"/>
    </template>
          <purpose>Provides calculation to find next nth month given a date. </purpose>
          <description>
            <para>This adjustment function provides the logic for 'month-based' advancement on a ymd based calendar. The policy it uses to handle the non existant end of month days is to back up to the last day of the month. Also, if the starting date is the last day of a month, this functor will attempt to adjust to the end of the month. </para>
          </description>
          <typedef name="duration_type">
            <type>date_type::duration_type</type>
          </typedef>
          <typedef name="cal_type">
            <type>date_type::calendar_type</type>
          </typedef>
          <typedef name="ymd_type">
            <type>cal_type::ymd_type</type>
          </typedef>
          <typedef name="day_type">
            <type>cal_type::day_type</type>
          </typedef>
          <method-group name="public member functions">
            <method name="get_offset" cv="const">
              <type>duration_type</type>
              <parameter name="d">
                <paramtype>const date_type &amp;</paramtype>
              </parameter>
            </method>
            <method name="get_neg_offset" cv="const">
              <type>duration_type</type>
              <parameter name="d">
                <paramtype>const date_type &amp;</paramtype>
              </parameter>
              <purpose>Returns a negative duration_type. </purpose>
            </method>
          </method-group>
          <constructor>
            <parameter name="f">
              <paramtype>int</paramtype>
            </parameter>
          </constructor>
        </class>
        <class name="week_functor">
          <template>
      <template-type-parameter name="date_type"/>
    </template>
          <purpose>Functor to iterate a over weeks. </purpose>
          <typedef name="duration_type">
            <type>date_type::duration_type</type>
          </typedef>
          <typedef name="calendar_type">
            <type>date_type::calendar_type</type>
          </typedef>
          <method-group name="public member functions">
            <method name="get_offset" cv="const">
              <type>duration_type</type>
              <parameter name="d">
                <paramtype>const date_type &amp;</paramtype>
              </parameter>
            </method>
            <method name="get_neg_offset" cv="const">
              <type>duration_type</type>
              <parameter name="d">
                <paramtype>const date_type &amp;</paramtype>
              </parameter>
            </method>
          </method-group>
          <constructor>
            <parameter name="f">
              <paramtype>int</paramtype>
            </parameter>
          </constructor>
        </class>
        <class name="year_functor">
          <template>
      <template-type-parameter name="date_type"/>
    </template>
          <purpose>Functor to iterate by a year adjusting for leap years. </purpose>
          <typedef name="duration_type">
            <type>date_type::duration_type</type>
          </typedef>
          <method-group name="public member functions">
            <method name="get_offset" cv="const">
              <type>duration_type</type>
              <parameter name="d">
                <paramtype>const date_type &amp;</paramtype>
              </parameter>
            </method>
            <method name="get_neg_offset" cv="const">
              <type>duration_type</type>
              <parameter name="d">
                <paramtype>const date_type &amp;</paramtype>
              </parameter>
            </method>
          </method-group>
          <constructor>
            <parameter name="f">
              <paramtype>int</paramtype>
            </parameter>
          </constructor>
        </class>
      </namespace>
    </namespace>
  </header>
  <header name="boost/date_time/c_local_time_adjustor.hpp">
    <para>Time adjustment calculations based on machine</para>
    <namespace name="boost">
      <namespace name="date_time">
        <class name="c_local_adjustor">
          <template>
      <template-type-parameter name="time_type"/>
    </template>
          <purpose>Adjust to / from utc using the C API. </purpose>
          <description>
            <para>Warning!!! This class assumes that timezone settings of the machine are correct. This can be a very dangerous assumption. </para>
          </description>
          <typedef name="time_duration_type">
            <type>time_type::time_duration_type</type>
          </typedef>
          <typedef name="date_type">
            <type>time_type::date_type</type>
          </typedef>
          <typedef name="date_duration_type">
            <type>date_type::duration_type</type>
          </typedef>
          <method-group name="public static functions">
            <method name="utc_to_local" cv="">
              <type>time_type</type>
              <parameter name="t">
                <paramtype>const time_type &amp;</paramtype>
              </parameter>
              <purpose>Convert a utc time to local time. </purpose>
            </method>
          </method-group>
        </class>
      </namespace>
    </namespace>
  </header>
  <header name="boost/date_time/c_time.hpp">
    <para>Provide workarounds related to the ctime header</para>
    <namespace name="std"/>
    <namespace name="boost">
      <namespace name="date_time">
        <struct name="c_time">
          <purpose>Provides a uniform interface to some 'ctime' functions. </purpose>
          <description>
            <para>Provides a uniform interface to some ctime functions and their '_r' counterparts. The '_r' functions require a pointer to a user created std::tm struct whereas the regular functions use a staticly created struct and return a pointer to that. These wrapper functions require the user to create a std::tm struct and send in a pointer to it. A pointer to the user created struct will be returned. </para>
          </description>
          <method-group name="public static functions">
            <method name="localtime" cv="">
              <type>std::tm *</type>
              <parameter name="t">
                <paramtype>const std::time_t *</paramtype>
              </parameter>
              <parameter name="result">
                <paramtype>std::tm *</paramtype>
              </parameter>
              <purpose>requires a pointer to a user created std::tm struct </purpose>
            </method>
            <method name="gmtime" cv="">
              <type>std::tm *</type>
              <parameter name="t">
                <paramtype>const std::time_t *</paramtype>
              </parameter>
              <parameter name="result">
                <paramtype>std::tm *</paramtype>
              </parameter>
              <purpose>requires a pointer to a user created std::tm struct </purpose>
            </method>
            <method name="localtime" cv="">
              <type>std::tm *</type>
              <parameter name="t">
                <paramtype>const std::time_t *</paramtype>
              </parameter>
              <parameter name="result">
                <paramtype>std::tm *</paramtype>
              </parameter>
              <purpose>requires a pointer to a user created std::tm struct </purpose>
            </method>
            <method name="gmtime" cv="">
              <type>std::tm *</type>
              <parameter name="t">
                <paramtype>const std::time_t *</paramtype>
              </parameter>
              <parameter name="result">
                <paramtype>std::tm *</paramtype>
              </parameter>
              <purpose>requires a pointer to a user created std::tm struct </purpose>
            </method>
          </method-group>
        </struct>
      </namespace>
    </namespace>
  </header>
  <header name="boost/date_time/compiler_config.hpp">
    <namespace name="std"/>
  </header>
  <header name="boost/date_time/constrained_value.hpp">
    <namespace name="boost">
      <namespace name="CV">
        <class name="constrained_value">
          <template>
      <template-type-parameter name="value_policies"/>
    </template>
          <purpose>A template to specify a constrained basic value type. </purpose>
          <description>
            <para>This template provides a quick way to generate an integer type with a constrained range. The type provides for the ability to specify the min, max, and and error handling policy.</para>
            <para><emphasis role="bold">value policies</emphasis>  A class that provides the range limits via the min and max functions as well as a function on_error that determines how errors are handled. A common strategy would be to assert or throw and exception. The on_error is passed both the current value and the new value that is in error. </para>
          </description>
          <typedef name="value_type">
            <type>value_policies::value_type</type>
          </typedef>
          <method-group name="public member functions">
            <method name="conversion-operator" cv="const">
              <type>value_type</type>
              <purpose>Coerce into the representation type. </purpose>
            </method>
          </method-group>
          <constructor>
            <parameter name="value">
              <paramtype>value_type</paramtype>
            </parameter>
          </constructor>
          <copy-assignment>
            <parameter name="v">
              <paramtype>value_type</paramtype>
            </parameter>
          </copy-assignment>
          <method-group name="public static functions">
            <method name="BOOST_PREVENT_MACRO_SUBSTITUTION" cv="">
              <type>value_type max</type>
              <purpose>Return the max allowed value (traits method). </purpose>
            </method>
            <method name="BOOST_PREVENT_MACRO_SUBSTITUTION" cv="">
              <type>value_type min</type>
              <purpose>Return the min allowed value (traits method). </purpose>
            </method>
          </method-group>
          <method-group name="private member functions">
            <method name="assign" cv="">
              <type>void</type>
              <parameter name="value">
                <paramtype>value_type</paramtype>
              </parameter>
            </method>
          </method-group>
        </class>
        <class name="simple_exception_policy">
          <template>
      <template-type-parameter name="rep_type"/>
      <template-nontype-parameter name="min_value"><type>rep_type</type></template-nontype-parameter>
      <template-nontype-parameter name="max_value"><type>rep_type</type></template-nontype-parameter>
      <template-type-parameter name="exception_type"/>
    </template>
          <purpose>Template to shortcut the constrained_value policy creation process. </purpose>
          <typedef name="value_type">
            <type>rep_type</type>
          </typedef>
          <method-group name="public static functions">
            <method name="BOOST_PREVENT_MACRO_SUBSTITUTION" cv="">
              <type>rep_type min</type>
            </method>