local_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-Jun-27 -->
<section id="local_time_reference">
<title>Local Time Reference</title>
  <header name="boost/date_time/local_time/conversion.hpp">
    <namespace name="boost">
      <namespace name="local_time">
        <function name="to_tm">
          <type>tm</type>
          <parameter name="lt">
            <paramtype>const <classname>local_date_time</classname> &amp;</paramtype>
          </parameter>
          <purpose>Function that creates a tm struct from a local_date_time. </purpose>
        </function>
      </namespace>
    </namespace>
  </header>
  <header name="boost/date_time/local_time/custom_time_zone.hpp">
    <namespace name="boost">
      <namespace name="local_time">
        <class name="custom_time_zone">
          <inherit access="public">boost::local_time::time_zone</inherit>
          <purpose>A real time zone. </purpose>
          <typedef name="time_duration_type">
            <type>boost::posix_time::time_duration</type>
          </typedef>
          <typedef name="base_type">
            <type>
              <classname>time_zone</classname>
            </type>
          </typedef>
          <typedef name="string_type">
            <type>base_type::string_type</type>
          </typedef>
          <typedef name="stringstream_type">
            <type>base_type::stringstream_type</type>
          </typedef>
          <method-group name="public member functions">
            <method name="dst_zone_abbrev" cv="const">
              <type>virtual std::string</type>
            </method>
            <method name="std_zone_abbrev" cv="const">
              <type>virtual std::string</type>
            </method>
            <method name="dst_zone_name" cv="const">
              <type>virtual std::string</type>
            </method>
            <method name="std_zone_name" cv="const">
              <type>virtual std::string</type>
            </method>
            <method name="has_dst" cv="const">
              <type>virtual bool</type>
              <purpose>True if zone uses daylight savings adjustments. </purpose>
            </method>
            <method name="dst_local_start_time" cv="const">
              <type>virtual posix_time::ptime</type>
              <parameter name="y">
                <paramtype>gregorian::greg_year</paramtype>
              </parameter>
              <purpose>Local time that DST starts -- NADT if has_dst is false. </purpose>
            </method>
            <method name="dst_local_end_time" cv="const">
              <type>virtual posix_time::ptime</type>
              <parameter name="y">
                <paramtype>gregorian::greg_year</paramtype>
              </parameter>
              <purpose>Local time that DST ends -- NADT if has_dst is false. </purpose>
            </method>
            <method name="base_utc_offset" cv="const">
              <type>virtual time_duration_type</type>
              <purpose>Base offset from UTC for zone (eg: -07:30:00). </purpose>
            </method>
            <method name="dst_offset" cv="const">
              <type>virtual time_duration_type</type>
              <purpose>Adjustment forward or back made while DST is in effect. </purpose>
            </method>
            <method name="to_posix_string" cv="const">
              <type>virtual string_type</type>
              <purpose>Returns a POSIX time_zone string for this object. </purpose>
            </method>
          </method-group>
          <constructor>
            <parameter name="zone_names">
              <paramtype>const time_zone_names &amp;</paramtype>
            </parameter>
            <parameter name="base_utc_offset">
              <paramtype>const time_duration_type &amp;</paramtype>
            </parameter>
            <parameter name="dst_offset">
              <paramtype>const dst_adjustment_offsets &amp;</paramtype>
            </parameter>
            <parameter name="calc_rule">
              <paramtype>boost::shared_ptr&lt; dst_calc_rule &gt;</paramtype>
            </parameter>
          </constructor>
          <destructor/>
        </class>
        <typedef name="dst_calc_rule_ptr">
          <type>boost::shared_ptr&lt; dst_calc_rule &gt;</type>
        </typedef>
      </namespace>
    </namespace>
  </header>
  <header name="boost/date_time/local_time/date_duration_operators.hpp">
    <para>Operators for local_date_time and optional gregorian types. Operators use snap-to-end-of-month behavior. Further details on this behavior can be found in reference for date_time/date_duration_types.hpp and documentation for month and year iterators.</para>
    <namespace name="boost">
      <namespace name="local_time">
        <function name="operator+">
          <type>
            <classname>local_date_time</classname>
          </type>
          <parameter name="t">
            <paramtype>const <classname>local_date_time</classname> &amp;</paramtype>
          </parameter>
          <parameter name="m">
            <paramtype>const boost::gregorian::months &amp;</paramtype>
          </parameter>
          <description>
            <para>Adds a months object and a local_date_time. Result will be same day-of-month as local_date_time unless original day was the last day of month. see date_time::months_duration for more details </para>
          </description>
        </function>
        <function name="operator+=">
          <type>
            <classname>local_date_time</classname>
          </type>
          <parameter name="t">
            <paramtype><classname>local_date_time</classname> &amp;</paramtype>
          </parameter>
          <parameter name="m">
            <paramtype>const boost::gregorian::months &amp;</paramtype>
          </parameter>
          <description>
            <para>Adds a months object to a local_date_time. Result will be same day-of-month as local_date_time unless original day was the last day of month. see date_time::months_duration for more details </para>
          </description>
        </function>
        <function name="operator-">
          <type>
            <classname>local_date_time</classname>
          </type>
          <parameter name="t">
            <paramtype>const <classname>local_date_time</classname> &amp;</paramtype>
          </parameter>
          <parameter name="m">
            <paramtype>const boost::gregorian::months &amp;</paramtype>
          </parameter>
          <description>
            <para>Subtracts a months object and a local_date_time. Result will be same day-of-month as local_date_time unless original day was the last day of month. see date_time::months_duration for more details </para>
          </description>
        </function>
        <function name="operator-=">
          <type>
            <classname>local_date_time</classname>
          </type>
          <parameter name="t">
            <paramtype><classname>local_date_time</classname> &amp;</paramtype>
          </parameter>
          <parameter name="m">
            <paramtype>const boost::gregorian::months &amp;</paramtype>
          </parameter>
          <description>
            <para>Subtracts a months object from a local_date_time. Result will be same day-of-month as local_date_time unless original day was the last day of month. see date_time::months_duration for more details </para>
          </description>
        </function>
        <function name="operator+">
          <type>
            <classname>local_date_time</classname>
          </type>
          <parameter name="t">
            <paramtype>const <classname>local_date_time</classname> &amp;</paramtype>
          </parameter>
          <parameter name="y">
            <paramtype>const boost::gregorian::years &amp;</paramtype>
          </parameter>
          <description>
            <para>Adds a years object and a local_date_time. Result will be same month and day-of-month as local_date_time unless original day was the last day of month. see date_time::years_duration for more details </para>
          </description>
        </function>
        <function name="operator+=">
          <type>
            <classname>local_date_time</classname>
          </type>
          <parameter name="t">
            <paramtype><classname>local_date_time</classname> &amp;</paramtype>
          </parameter>
          <parameter name="y">
            <paramtype>const boost::gregorian::years &amp;</paramtype>
          </parameter>
          <description>
            <para>Adds a years object to a local_date_time. Result will be same month and day-of-month as local_date_time unless original day was the last day of month. see date_time::years_duration for more details </para>
          </description>
        </function>
        <function name="operator-">
          <type>
            <classname>local_date_time</classname>
          </type>
          <parameter name="t">
            <paramtype>const <classname>local_date_time</classname> &amp;</paramtype>
          </parameter>
          <parameter name="y">
            <paramtype>const boost::gregorian::years &amp;</paramtype>
          </parameter>
          <description>
            <para>Subtracts a years object and a local_date_time. Result will be same month and day-of-month as local_date_time unless original day was the last day of month. see date_time::years_duration for more details </para>
          </description>
        </function>
        <function name="operator-=">
          <type>
            <classname>local_date_time</classname>
          </type>
          <parameter name="t">
            <paramtype><classname>local_date_time</classname> &amp;</paramtype>
          </parameter>
          <parameter name="y">
            <paramtype>const boost::gregorian::years &amp;</paramtype>
          </parameter>
          <description>
            <para>Subtracts a years object from a local_date_time. Result will be same month and day-of-month as local_date_time unless original day was the last day of month. see date_time::years_duration for more details </para>
          </description>
        </function>
      </namespace>
    </namespace>
  </header>
  <header name="boost/date_time/local_time/dst_transition_day_rules.hpp">
    <namespace name="boost">
      <namespace name="local_time">
        <struct name="partial_date_rule_spec">
          <typedef name="date_type">
            <type>gregorian::date</type>
          </typedef>
          <typedef name="start_rule">
            <type>gregorian::partial_date</type>
          </typedef>
          <typedef name="end_rule">
            <type>gregorian::partial_date</type>
          </typedef>
        </struct>
        <struct name="first_last_rule_spec">
          <typedef name="date_type">
            <type>gregorian::date</type>
          </typedef>
          <typedef name="start_rule">
            <type>gregorian::first_kday_of_month</type>
          </typedef>
          <typedef name="end_rule">
            <type>gregorian::last_kday_of_month</type>
          </typedef>
        </struct>
        <struct name="last_last_rule_spec">
          <typedef name="date_type">
            <type>gregorian::date</type>
          </typedef>
          <typedef name="start_rule">
            <type>gregorian::last_kday_of_month</type>
          </typedef>
          <typedef name="end_rule">
            <type>gregorian::last_kday_of_month</type>
          </typedef>
        </struct>
        <struct name="nth_last_rule_spec">
          <typedef name="date_type">
            <type>gregorian::date</type>
          </typedef>
          <typedef name="start_rule">
            <type>gregorian::nth_kday_of_month</type>
          </typedef>
          <typedef name="end_rule">
            <type>gregorian::last_kday_of_month</type>