date_time_autodoc.boostbook

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

            <method name="BOOST_PREVENT_MACRO_SUBSTITUTION" cv="">
              <type>rep_type max</type>
            </method>
            <method name="on_error" cv="">
              <type>void</type>
              <parameter name="">
                <paramtype>rep_type</paramtype>
              </parameter>
              <parameter name="">
                <paramtype>rep_type</paramtype>
              </parameter>
              <parameter name="">
                <paramtype>violation_enum</paramtype>
              </parameter>
            </method>
          </method-group>
        </class>
        <enum name="violation_enum">
          <enumvalue name="min_violation"/>
          <enumvalue name="max_violation"/>
          <purpose>Represent a min or max violation type. </purpose>
        </enum>
      </namespace>
    </namespace>
  </header>
  <header name="boost/date_time/date.hpp">
    <namespace name="boost">
      <namespace name="date_time">
        <class name="date">
          <template>
      <template-type-parameter name="T"/>
      <template-type-parameter name="calendar"/>
      <template-type-parameter name="duration_type_"/>
    </template>
          <purpose>Representation of timepoint at the one day level resolution. </purpose>
          <description>
            <para>The date template represents an interface shell for a date class that is based on a year-month-day system such as the gregorian or iso systems. It provides basic operations to enable calculation and comparisons.</para>
            <para><emphasis role="bold">Theory</emphasis> </para>
            <para>This date representation fundamentally departs from the C tm struct approach. The goal for this type is to provide efficient date operations (add, subtract) and storage (minimize space to represent) in a concrete class. Thus, the date uses a count internally to represent a particular date. The calendar parameter defines the policies for converting the the year-month-day and internal counted form here. Applications that need to perform heavy formatting of the same date repeatedly will perform better by using the year-month-day representation.</para>
            <para>Internally the date uses a day number to represent the date. This is a monotonic time representation. This representation allows for fast comparison as well as simplifying the creation of writing numeric operations. Essentially, the internal day number is like adjusted julian day. The adjustment is determined by the Epoch date which is represented as day 1 of the calendar. Day 0 is reserved for negative infinity so that any actual date is automatically greater than negative infinity. When a date is constructed from a date or formatted for output, the appropriate conversions are applied to create the year, month, day representations. </para>
          </description>
          <typedef name="date_type">
            <type>T</type>
          </typedef>
          <typedef name="calendar_type">
            <type>calendar</type>
          </typedef>
          <typedef name="traits_type">
            <type>calendar::date_traits_type</type>
          </typedef>
          <typedef name="duration_type">
            <type>duration_type_</type>
          </typedef>
          <typedef name="year_type">
            <type>calendar::year_type</type>
          </typedef>
          <typedef name="month_type">
            <type>calendar::month_type</type>
          </typedef>
          <typedef name="day_type">
            <type>calendar::day_type</type>
          </typedef>
          <typedef name="ymd_type">
            <type>calendar::ymd_type</type>
          </typedef>
          <typedef name="date_rep_type">
            <type>calendar::date_rep_type</type>
          </typedef>
          <typedef name="date_int_type">
            <type>calendar::date_int_type</type>
          </typedef>
          <typedef name="day_of_week_type">
            <type>calendar::day_of_week_type</type>
          </typedef>
          <method-group name="public member functions">
            <method name="year" cv="const">
              <type>year_type</type>
            </method>
            <method name="month" cv="const">
              <type>month_type</type>
            </method>
            <method name="day" cv="const">
              <type>day_type</type>
            </method>
            <method name="day_of_week" cv="const">
              <type>day_of_week_type</type>
            </method>
            <method name="year_month_day" cv="const">
              <type>ymd_type</type>
            </method>
            <method name="operator&lt;" cv="const">
              <type>bool</type>
              <parameter name="rhs">
                <paramtype>const date_type &amp;</paramtype>
              </parameter>
            </method>
            <method name="operator==" cv="const">
              <type>bool</type>
              <parameter name="rhs">
                <paramtype>const date_type &amp;</paramtype>
              </parameter>
            </method>
            <method name="is_special" cv="const">
              <type>bool</type>
              <purpose>check to see if date is a special value </purpose>
            </method>
            <method name="is_not_a_date" cv="const">
              <type>bool</type>
              <purpose>check to see if date is not a value </purpose>
            </method>
            <method name="is_infinity" cv="const">
              <type>bool</type>
              <purpose>check to see if date is one of the infinity values </purpose>
            </method>
            <method name="is_pos_infinity" cv="const">
              <type>bool</type>
              <purpose>check to see if date is greater than all possible dates </purpose>
            </method>
            <method name="is_neg_infinity" cv="const">
              <type>bool</type>
              <purpose>check to see if date is greater than all possible dates </purpose>
            </method>
            <method name="as_special" cv="const">
              <type>special_values</type>
              <purpose>return as a special value or a not_special if a normal date </purpose>
            </method>
            <method name="operator-" cv="const">
              <type>duration_type</type>
              <parameter name="d">
                <paramtype>const date_type &amp;</paramtype>
              </parameter>
            </method>
            <method name="operator-" cv="const">
              <type>date_type</type>
              <parameter name="dd">
                <paramtype>const duration_type &amp;</paramtype>
              </parameter>
            </method>
            <method name="operator-=" cv="">
              <type>date_type</type>
              <parameter name="dd">
                <paramtype>const duration_type &amp;</paramtype>
              </parameter>
            </method>
            <method name="day_count" cv="const">
              <type>date_rep_type</type>
            </method>
            <method name="operator+" cv="const">
              <type>date_type</type>
              <parameter name="dd">
                <paramtype>const duration_type &amp;</paramtype>
              </parameter>
            </method>
            <method name="operator+=" cv="">
              <type>date_type</type>
              <parameter name="dd">
                <paramtype>const duration_type &amp;</paramtype>
              </parameter>
            </method>
          </method-group>
          <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>
          </constructor>
          <constructor>
            <parameter name="ymd">
              <paramtype>const ymd_type &amp;</paramtype>
            </parameter>
          </constructor>
          <method-group name="protected member functions"/>
          <constructor>
            <parameter name="days">
              <paramtype>date_int_type</paramtype>
            </parameter>
            <description>
              <para>This is a private constructor which allows for the creation of new dates. It is not exposed to users since that would require class users to understand the inner workings of the date class. </para>
            </description>
          </constructor>
          <constructor>
            <parameter name="days">
              <paramtype>date_rep_type</paramtype>
            </parameter>
          </constructor>
        </class>
      </namespace>
    </namespace>
  </header>
  <header name="boost/date_time/date_clock_device.hpp">
    <namespace name="boost">
      <namespace name="date_time">
        <class name="day_clock">
          <template>
      <template-type-parameter name="date_type"/>
    </template>
          <purpose>A clock providing day level services based on C time_t capabilities. </purpose>
          <description>
            <para>This clock uses Posix interfaces as its implementation and hence uses the timezone settings of the operating system. Incorrect user settings will result in incorrect results for the calls to local_day. </para>
          </description>
          <typedef name="ymd_type">
            <type>date_type::ymd_type</type>
          </typedef>
          <method-group name="public static functions">
            <method name="local_day" cv="">
              <type>date_type</type>
              <purpose>Get the local day as a date type. </purpose>
            </method>
            <method name="local_day_ymd" cv="">
              <type>date_type::ymd_type</type>
              <purpose>Get the local day as a ymd_type. </purpose>
            </method>
            <method name="universal_day_ymd" cv="">
              <type>date_type::ymd_type</type>
              <purpose>Get the current day in universal date as a ymd_type. </purpose>
            </method>
            <method name="universal_day" cv="">
              <type>date_type</type>
              <purpose>Get the UTC day as a date type. </purpose>
            </method>
          </method-group>
          <method-group name="private static functions">
            <method name="get_local_time" cv="">
              <type>::std::tm *</type>
              <parameter name="result">
                <paramtype>std::tm &amp;</paramtype>
              </parameter>
            </method>
            <method name="get_universal_time" cv="">
              <type>::std::tm *</type>
              <parameter name="result">
                <paramtype>std::tm &amp;</paramtype>
              </parameter>
            </method>
          </method-group>
        </class>
      </namespace>
    </namespace>
  </header>
  <header name="boost/date_time/date_defs.hpp">
    <namespace name="boost">
      <namespace name="date_time">
        <enum name="weekdays">
          <enumvalue name="Sunday"/>
          <enumvalue name="Monday"/>
          <enumvalue name="Tuesday"/>
          <enumvalue name="Wednesday"/>
          <enumvalue name="Thursday"/>
          <enumvalue name="Friday"/>
          <enumvalue name="Saturday"/>
          <purpose>An enumeration of weekday names. </purpose>
        </enum>
        <enum name="months_of_year">
          <enumvalue name="Jan">
            <default>1</default>
          </enumvalue>
          <enumvalue name="Feb"/>
          <enumvalue name="Mar"/>
          <enumvalue name="Apr"/>
          <enumvalue name="May"/>
          <enumvalue name="Jun"/>
          <enumvalue name="Jul"/>
          <enumvalue name="Aug"/>
          <enumvalue name="Sep"/>
          <enumvalue name="Oct"/>
          <enumvalue name="Nov"/>
          <enumvalue name="Dec"/>
          <enumvalue name="NotAMonth"/>
          <enumvalue name="NumMonths"/>
          <purpose>Simple enum to allow for nice programming with Jan, Feb, etc. </purpose>
        </enum>
      </namespace>
    </namespace>
  </header>
  <header name="boost/date_time/date_duration.hpp">
    <namespace name="boost">
      <namespace name="date_time">
        <class name="date_duration">
          <template>
      <template-type-parameter name="duration_rep_traits"/>
    </template>
          <purpose>Duration type with date level resolution. </purpose>
          <typedef name="duration_rep_type">
            <type>duration_rep_traits::int_type</type>
          </typedef>
          <typedef name="duration_rep">
            <type>duration_rep_traits::impl_type</type>
          </typedef>
          <method-group name="public member functions">
            <method name="get_rep" cv="const">
              <type>duration_rep</type>
              <purpose>returns days_ as it's instantiated type - used for streaming </purpose>
            </method>
            <method name="is_special" cv="const">
              <type>bool</type>