posix_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="posix_time_reference">
<title>Posix Time Reference</title>
  <header name="boost/date_time/posix_time/conversion.hpp">
    <namespace name="boost">
      <namespace name="posix_time">
        <function name="from_time_t">
          <type>
            <classname>ptime</classname>
          </type>
          <parameter name="t">
            <paramtype>std::time_t</paramtype>
          </parameter>
          <purpose>Function that converts a time_t into a ptime. </purpose>
        </function>
        <function name="to_tm">
          <type>tm</type>
          <parameter name="t">
            <paramtype>const <classname>boost::posix_time::ptime</classname> &amp;</paramtype>
          </parameter>
          <purpose>Convert a time to a tm structure truncating any fractional seconds. </purpose>
        </function>
        <function name="to_tm">
          <type>tm</type>
          <parameter name="td">
            <paramtype>const <classname>boost::posix_time::time_duration</classname> &amp;</paramtype>
          </parameter>
          <purpose>Convert a time_duration to a tm structure truncating any fractional seconds and zeroing fields for date components. </purpose>
        </function>
        <function name="ptime_from_tm">
          <type>
            <classname>ptime</classname>
          </type>
          <parameter name="timetm">
            <paramtype>const tm &amp;</paramtype>
          </parameter>
          <purpose>Convert a tm struct to a ptime ignoring is_dst flag. </purpose>
        </function>
        <function name="from_ftime">
          <type>time_type</type>
          <template>
          <template-type-parameter name="time_type"/>
        </template>
          <parameter name="ft">
            <paramtype>const FILETIME &amp;</paramtype>
          </parameter>
          <purpose>Function to create a time object from an initialized FILETIME struct. </purpose>
          <description>
            <para>Function to create a time object from an initialized FILETIME struct. A FILETIME struct holds 100-nanosecond units (0.0000001). When built with microsecond resolution the FILETIME's sub second value will be truncated. Nanosecond resolution has no truncation.</para>
            <para>Note ftime is part of the Win32 API, so it is not portable to non-windows platforms. </para>
          </description>
        </function>
      </namespace>
    </namespace>
  </header>
  <header name="boost/date_time/posix_time/date_duration_operators.hpp">
    <para>Operators for ptime 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="posix_time">
        <function name="operator+">
          <type>
            <classname>ptime</classname>
          </type>
          <parameter name="t">
            <paramtype>const <classname>ptime</classname> &amp;</paramtype>
          </parameter>
          <parameter name="m">
            <paramtype>const boost::gregorian::months &amp;</paramtype>
          </parameter>
          <description>
            <para>Adds a months object and a ptime. Result will be same day-of-month as ptime 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>ptime</classname>
          </type>
          <parameter name="t">
            <paramtype><classname>ptime</classname> &amp;</paramtype>
          </parameter>
          <parameter name="m">
            <paramtype>const boost::gregorian::months &amp;</paramtype>
          </parameter>
          <description>
            <para>Adds a months object to a ptime. Result will be same day-of-month as ptime 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>ptime</classname>
          </type>
          <parameter name="t">
            <paramtype>const <classname>ptime</classname> &amp;</paramtype>
          </parameter>
          <parameter name="m">
            <paramtype>const boost::gregorian::months &amp;</paramtype>
          </parameter>
          <description>
            <para>Subtracts a months object and a ptime. Result will be same day-of-month as ptime 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>ptime</classname>
          </type>
          <parameter name="t">
            <paramtype><classname>ptime</classname> &amp;</paramtype>
          </parameter>
          <parameter name="m">
            <paramtype>const boost::gregorian::months &amp;</paramtype>
          </parameter>
          <description>
            <para>Subtracts a months object from a ptime. Result will be same day-of-month as ptime 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>ptime</classname>
          </type>
          <parameter name="t">
            <paramtype>const <classname>ptime</classname> &amp;</paramtype>
          </parameter>
          <parameter name="y">
            <paramtype>const boost::gregorian::years &amp;</paramtype>
          </parameter>
          <description>
            <para>Adds a years object and a ptime. Result will be same month and day-of-month as ptime 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>ptime</classname>
          </type>
          <parameter name="t">
            <paramtype><classname>ptime</classname> &amp;</paramtype>
          </parameter>
          <parameter name="y">
            <paramtype>const boost::gregorian::years &amp;</paramtype>
          </parameter>
          <description>
            <para>Adds a years object to a ptime. Result will be same month and day-of-month as ptime 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>ptime</classname>
          </type>
          <parameter name="t">
            <paramtype>const <classname>ptime</classname> &amp;</paramtype>
          </parameter>
          <parameter name="y">
            <paramtype>const boost::gregorian::years &amp;</paramtype>
          </parameter>
          <description>
            <para>Subtracts a years object and a ptime. Result will be same month and day-of-month as ptime 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>ptime</classname>
          </type>
          <parameter name="t">
            <paramtype><classname>ptime</classname> &amp;</paramtype>
          </parameter>
          <parameter name="y">
            <paramtype>const boost::gregorian::years &amp;</paramtype>
          </parameter>
          <description>
            <para>Subtracts a years object from a ptime. Result will be same month and day-of-month as ptime 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/posix_time/posix_time.hpp">
    <para>Global header file to get all of posix time types</para>
  </header>
  <header name="boost/date_time/posix_time/posix_time_config.hpp">
    <namespace name="boost">
      <namespace name="posix_time">
        <class name="time_duration">
          <purpose>Base time duration type. </purpose>
          <typedef name="rep_type">
            <type>time_res_traits</type>
          </typedef>
          <typedef name="day_type">
            <type>time_res_traits::day_type</type>
          </typedef>
          <typedef name="hour_type">
            <type>time_res_traits::hour_type</type>
          </typedef>
          <typedef name="min_type">
            <type>time_res_traits::min_type</type>
          </typedef>
          <typedef name="sec_type">
            <type>time_res_traits::sec_type</type>
          </typedef>
          <typedef name="fractional_seconds_type">
            <type>time_res_traits::fractional_seconds_type</type>
          </typedef>
          <typedef name="tick_type">
            <type>time_res_traits::tick_type</type>
          </typedef>
          <typedef name="impl_type">
            <type>time_res_traits::impl_type</type>
          </typedef>
          <method-group name="public member functions"/>
          <constructor>
            <parameter name="hour">
              <paramtype>hour_type</paramtype>
            </parameter>
            <parameter name="min">
              <paramtype>min_type</paramtype>
            </parameter>
            <parameter name="sec">
              <paramtype>sec_type</paramtype>
            </parameter>
            <parameter name="fs">
              <paramtype>fractional_seconds_type</paramtype>
              <default>0</default>
            </parameter>
          </constructor>
          <constructor/>
          <constructor>
            <parameter name="sv">
              <paramtype>boost::date_time::special_values</paramtype>
            </parameter>
            <purpose>Construct from special_values. </purpose>
          </constructor>
          <method-group name="private member functions"/>
          <constructor>
            <parameter name="ticks">
              <paramtype>impl_type</paramtype>
            </parameter>
          </constructor>
        </class>
        <struct name="simple_time_rep">
          <purpose>Simple implementation for the time rep. </purpose>
          <typedef name="date_type">
            <type>gregorian::date</type>
          </typedef>
          <typedef name="time_duration_type">
            <type>
              <classname>time_duration</classname>
            </type>
          </typedef>
          <method-group name="public member functions">
            <method name="is_special" cv="const">
              <type>bool</type>
            </method>
            <method name="is_pos_infinity" cv="const">
              <type>bool</type>
            </method>
            <method name="is_neg_infinity" cv="const">
              <type>bool</type>
            </method>
            <method name="is_not_a_date_time" cv="const">
              <type>bool</type>
            </method>
          </method-group>
          <constructor>
            <parameter name="d">
              <paramtype>date_type</paramtype>
            </parameter>
            <parameter name="tod">
              <paramtype>
                <classname>time_duration_type</classname>
              </paramtype>
            </parameter>
          </constructor>
          <data-member name="day">
            <type>date_type</type>
          </data-member>
          <data-member name="time_of_day">
            <type>
              <classname>time_duration_type</classname>
            </type>
          </data-member>
        </struct>
        <class name="posix_time_system_config">
          <typedef name="time_rep_type">
            <type>
              <classname>simple_time_rep</classname>
            </type>
          </typedef>
          <typedef name="date_type">
            <type>gregorian::date</type>
          </typedef>
          <typedef name="date_duration_type">
            <type>gregorian::date_duration</type>
          </typedef>
          <typedef name="time_duration_type">
            <type>
              <classname>time_duration</classname>
            </type>
          </typedef>
          <typedef name="int_type">
            <type>time_res_traits::tick_type</type>
          </typedef>
          <typedef name="resolution_traits">
            <type>time_res_traits</type>
          </typedef>
          <method-group name="public member functions">
            <method name="BOOST_STATIC_CONSTANT" cv="">