• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1/* Copyright (c) 2001-2004 CrystalClear Software, Inc.
2 * Use, modification and distribution is subject to the
3 * Boost Software License, Version 1.0. (See accompanying
4 * file LICENSE_1_0.txt or http://www.boost.org/LICENSE_1_0.txt)
5 * Author: Jeff Garland
6 * $Date$
7 */
8
9
10/*! @mainpage Boost Date-Time Library Reference Documentation
11 *
12 *
13 *@section intro Introduction
14 *
15 * The Boost Date-Time Library (originally the Generic Date-Time Library or GDTL)
16 * is a set of C++ date-time libraries based on the concepts of generic programming.
17 * This is an online reference guide generated from the source code
18 * that provides a handy way to learn about the details of the
19 * library.  If you are a user you should start with the
20 * <a href="../user_docs/index.html">User Documentation</a>.
21 *
22 *@section using Using This Documentation
23 *
24 * The online documentation provides extensive information about the details
25 * of the library including:
26 * - <A href="inherits.html">Class hierarchy</A>
27 * - <A href="namespaces.html">Namespace Documentation</A>
28 * - List of <A href="files.html">source files</A>
29 * - Annotated list of classes and structs
30 *   <A href="annotated.html">(Compound List)</A>
31 *
32 * For example, suppose you wanted to learn more about the
33 * gregorian::greg_month class.
34 * You could alternatively browse the
35 * - <A href="classboost_1_1gregorian_1_1greg__month.html">Class documentation page</A>
36 * - Include dependencies for greg_month.hpp
37 * - Hyperlinked and colorized source files: <A href="greg__month_8hpp-source.html">[hpp file]</A> <A href="greg__month_8cpp-source.html">[cpp file]</A>
38 *
39 * The main navigation bar at the top provides that access to many
40 * different modes of naviation through the library.
41
42 *
43 */
44
45//! Overall boost namespace -- library does not put any symbols here
46namespace boost {
47
48//! Namespace for basic templates and components used to construct date-time systems
49/*!
50 This namespace encapsulates various types of templates and classes used
51 to construct coherent date-time systems including date, time, etc.  These
52 components should be considered helper components to be utilized in the
53 construction of specific date-time system implementations.  See namespace
54 gregorian for one such example.
55*/
56namespace date_time {}
57
58}
59/*! Namespace for the c++ standard library.  Library does not define any symbols in the namespace, but uses some classes from this namespace.
60*/
61namespace std {}
62
63/*!\class std::out_of_range
64   \brief Exception class defined in c++ standard library.
65  A derivative of std::logic_error and std::exception and base class for
66  many exceptions in the library.  See also:
67
68   <a href="http://docs.mandragor.org/files/Programming_languages/Cpp/libstdcpp_v3_Source_Documentation/classstd_1_1out__of__range.html">Mandragor docs for libstdcpp_v3 std::out_of_range</a>
69*/
70
71
72
73