local_time_autodoc.boostbook

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

              </parameter>
              <purpose>Local_date_time - time_duration. </purpose>
            </method>
            <method name="operator-=" cv="">
              <type>
                <classname>local_date_time_base</classname>
              </type>
              <parameter name="td">
                <paramtype>const time_duration_type &amp;</paramtype>
              </parameter>
              <purpose>Local_date_time -= time_duration. </purpose>
            </method>
            <method name="operator-" cv="const">
              <type>time_duration_type</type>
              <parameter name="rhs">
                <paramtype>const <classname>local_date_time_base</classname> &amp;</paramtype>
              </parameter>
              <purpose>local_date_time -= local_date_time --&gt; time_duration_type </purpose>
            </method>
          </method-group>
          <constructor>
            <parameter name="t">
              <paramtype>utc_time_type</paramtype>
              <description>
                <para>A UTC time </para>
              </description>
            </parameter>
            <parameter name="tz">
              <paramtype>boost::shared_ptr&lt; tz_type &gt;</paramtype>
              <description>
                <para>Timezone for to adjust the UTC time to. </para>
              </description>
            </parameter>
            <description>
              <para>This constructor interprets the passed time as a UTC time. So, for example, if the passed timezone is UTC-5 then the time will be adjusted back 5 hours. The time zone allows for automatic calculation of whether the particular time is adjusted for daylight savings, etc. If the time zone shared pointer is null then time stays unadjusted. 
</para>
            </description>
          </constructor>
          <constructor>
            <parameter name="d">
              <paramtype>date_type</paramtype>
            </parameter>
            <parameter name="td">
              <paramtype>time_duration_type</paramtype>
            </parameter>
            <parameter name="tz">
              <paramtype>boost::shared_ptr&lt; tz_type &gt;</paramtype>
            </parameter>
            <parameter name="dst_flag">
              <paramtype>bool</paramtype>
            </parameter>
            <description>
              <para>This constructs a local time -- the passed time information understood to be in the passed tz. The DST flag must be passed to indicate whether the time is in daylight savings or not. 
</para>
            </description>
            <throws>
              <simpara><classname>--</classname> time_label_invalid if the time passed does not exist in the given locale. The non-existent case occurs typically during the shift-back from daylight savings time. When the clock is shifted forward a range of times (2 am to 3 am in the US) is skipped and hence is invalid. dst_not_valid if the DST flag is passed for a period where DST is not active. </simpara>
            </throws>
          </constructor>
          <constructor>
            <parameter name="d">
              <paramtype>date_type</paramtype>
            </parameter>
            <parameter name="td">
              <paramtype>time_duration_type</paramtype>
            </parameter>
            <parameter name="tz">
              <paramtype>boost::shared_ptr&lt; tz_type &gt;</paramtype>
            </parameter>
            <parameter name="calc_option">
              <paramtype>DST_CALC_OPTIONS</paramtype>
            </parameter>
            <description>
              <para>This constructs a local time -- the passed time information understood to be in the passed tz. The DST flag is calculated according to the specified rule. </para>
            </description>
          </constructor>
          <destructor>
            <purpose>Simple destructor, releases time zone if last referrer. </purpose>
          </destructor>
          <constructor>
            <parameter name="rhs">
              <paramtype>const <classname>local_date_time_base</classname> &amp;</paramtype>
            </parameter>
            <purpose>Copy constructor. </purpose>
          </constructor>
          <constructor>
            <parameter name="sv">
              <paramtype>const boost::date_time::special_values</paramtype>
            </parameter>
            <parameter name="tz">
              <paramtype>boost::shared_ptr&lt; tz_type &gt;</paramtype>
              <default>boost::shared_ptr&lt; tz_type &gt;()</default>
            </parameter>
            <purpose>Special values constructor. </purpose>
          </constructor>
          <method-group name="public static functions">
            <method name="check_dst" cv="">
              <type>time_is_dst_result</type>
              <parameter name="d">
                <paramtype>date_type</paramtype>
              </parameter>
              <parameter name="td">
                <paramtype>time_duration_type</paramtype>
              </parameter>
              <parameter name="tz">
                <paramtype>boost::shared_ptr&lt; tz_type &gt;</paramtype>
              </parameter>
              <purpose>Determines if given time label is in daylight savings for given zone. </purpose>
              <description>
                <para>Determines if given time label is in daylight savings for given zone. Takes a date and time_duration representing a local time, along with time zone, and returns a time_is_dst_result object as result. </para>
              </description>
            </method>
          </method-group>
          <method-group name="private member functions">
            <method name="construction_adjustment" cv="">
              <type>utc_time_type</type>
              <parameter name="t">
                <paramtype>utc_time_type</paramtype>
              </parameter>
              <parameter name="zone">
                <paramtype>boost::shared_ptr&lt; tz_type &gt;</paramtype>
              </parameter>
              <parameter name="is_dst">
                <paramtype>bool</paramtype>
              </parameter>
              <description>
                <para>Adjust the passed in time to UTC? </para>
              </description>
            </method>
            <method name="zone_as_offset" cv="const">
              <type>std::string</type>
              <parameter name="td">
                <paramtype>const time_duration_type &amp;</paramtype>
              </parameter>
              <parameter name="separator">
                <paramtype>const std::string &amp;</paramtype>
              </parameter>
              <description>
                <para>Simple formatting code -- todo remove this? </para>
              </description>
            </method>
          </method-group>
        </class>
        <typedef name="local_date_time">
          <purpose>Use the default parameters to define local_date_time. </purpose>
          <type>
            <classname>local_date_time_base</classname>
          </type>
        </typedef>
      </namespace>
    </namespace>
  </header>
  <header name="boost/date_time/local_time/local_time.hpp"/>
  <header name="boost/date_time/local_time/local_time_io.hpp">
    <namespace name="boost">
      <namespace name="local_time">
        <typedef name="wlocal_time_facet">
          <type>boost::date_time::time_facet&lt; <classname>local_date_time</classname>, wchar_t &gt;</type>
        </typedef>
        <typedef name="local_time_facet">
          <type>boost::date_time::time_facet&lt; <classname>local_date_time</classname>, char &gt;</type>
        </typedef>
        <typedef name="wlocal_time_input_facet">
          <type>boost::date_time::time_input_facet&lt; local_date_time::utc_time_type, wchar_t &gt;</type>
        </typedef>
        <typedef name="local_time_input_facet">
          <type>boost::date_time::time_input_facet&lt; local_date_time::utc_time_type, char &gt;</type>
        </typedef>
        <function name="operator&lt;&lt;">
          <type>std::basic_ostream&lt; CharT, TraitsT &gt; &amp;</type>
          <template>
          <template-type-parameter name="CharT"/>
          <template-type-parameter name="TraitsT"/>
        </template>
          <parameter name="os">
            <paramtype>std::basic_ostream&lt; CharT, TraitsT &gt; &amp;</paramtype>
          </parameter>
          <parameter name="ldt">
            <paramtype>const <classname>local_date_time</classname> &amp;</paramtype>
          </parameter>
          <purpose>operator&lt;&lt; for local_date_time - see local_time docs for formatting details </purpose>
        </function>
        <function name="operator&gt;&gt;">
          <type>std::basic_istream&lt; CharT, Traits &gt; &amp;</type>
          <template>
          <template-type-parameter name="CharT"/>
          <template-type-parameter name="Traits"/>
        </template>
          <parameter name="is">
            <paramtype>std::basic_istream&lt; CharT, Traits &gt; &amp;</paramtype>
          </parameter>
          <parameter name="ldt">
            <paramtype><classname>local_date_time</classname> &amp;</paramtype>
          </parameter>
          <purpose>input operator for local_date_time </purpose>
        </function>
      </namespace>
    </namespace>
  </header>
  <header name="boost/date_time/local_time/local_time_serialize.hpp">
    <namespace name="boost">
      <namespace name="serialization">
        <function name="BOOST_SERIALIZATION_SPLIT_FREE">
          <type/>
          <parameter name="">
            <paramtype>boost::date_time::time_zone_base</paramtype>
          </parameter>
        </function>
        <data-member name="tz">
          <type>const shared_ptr&lt; date_time::time_zone_base&lt; posix_time::ptime &gt; &gt;</type>
        </data-member>
      </namespace>
    </namespace>
  </header>
  <header name="boost/date_time/local_time/local_time_types.hpp">
    <namespace name="boost">
      <namespace name="local_time">
        <typedef name="local_time_period">
          <type>boost::date_time::period&lt; <classname>local_date_time</classname>, boost::posix_time::time_duration &gt;</type>
        </typedef>
        <typedef name="local_time_iterator">
          <type>date_time::time_itr&lt; <classname>local_date_time</classname> &gt;</type>
        </typedef>
        <typedef name="local_sec_clock">
          <type>date_time::second_clock&lt; <classname>local_date_time</classname> &gt;</type>
        </typedef>
        <typedef name="local_microsec_clock">
          <type>date_time::microsec_clock&lt; <classname>local_date_time</classname> &gt;</type>
        </typedef>
        <typedef name="time_zone_ptr">
          <purpose>Shared Pointer for time_zone and posix_time_zone objects. </purpose>
          <type>boost::shared_ptr&lt; <classname>time_zone</classname> &gt;</type>
        </typedef>
      </namespace>
    </namespace>
  </header>
  <header name="boost/date_time/local_time/posix_time_zone.hpp">
    <namespace name="boost">
      <namespace name="local_time">
        <struct name="bad_offset">
          <purpose>simple exception for UTC and Daylight savings start/end offsets </purpose>
          <method-group name="public member functions"/>
          <constructor>
            <parameter name="_msg">
              <paramtype>std::string</paramtype>
              <default>""</default>
            </parameter>
          </constructor>
        </struct>
        <struct name="bad_adjustment">
          <purpose>simple exception for UTC daylight savings adjustment </purpose>
          <method-group name="public member functions"/>
          <constructor>
            <parameter name="_msg">
              <paramtype>std::string</paramtype>
              <default>""</default>
            </parameter>
          </constructor>
        </struct>
        <class name="posix_time_zone">
          <inherit access="public">boost::local_time::time_zone</inherit>
          <purpose>A time zone class constructed from a POSIX time zone string. </purpose>
          <description>
            <para>A POSIX time zone string takes the form of:&lt;br&gt; "std offset dst [offset],start[/time],end[/time]" (w/no spaces) 'std' specifies the abbrev of the time zone.
 'offset' is the offset from UTC.
 'dst' specifies the abbrev of the time zone during daylight savings time.
 The second offset is how many hours changed during DST. Default=1
 'start' and'end' are the dates when DST goes into (and out of) effect.
 'offset' takes the form of: [+|-]hh[:mm[:ss]] {h=0-23, m/s=0-59}
 'time' and 'offset' take the same form. Time defaults=02:00:00
 'start' and 'end' can be one of three forms:&lt;br&gt; Mm.w.d {month=1-12, week=1-5 (5 is always last), day=0-6}