Doxygen updates

This commit is contained in:
Randolph Voorhies 2013-07-06 19:24:31 -07:00
parent af8ba33d63
commit 0ce654759a
21 changed files with 36 additions and 25 deletions

View File

@ -615,7 +615,7 @@ CITE_BIB_FILES =
# The QUIET tag can be used to turn on/off the messages that are generated
# by doxygen. Possible values are YES and NO. If left blank NO is used.
QUIET = NO
QUIET = YES
# The WARNINGS tag can be used to turn on/off the warning messages that are
# generated by doxygen. Possible values are YES and NO. If left blank
@ -627,7 +627,7 @@ WARNINGS = YES
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
# automatically be disabled.
WARN_IF_UNDOCUMENTED = YES
WARN_IF_UNDOCUMENTED = NO
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
# potential errors in the documentation, such as not documenting some

View File

@ -39,9 +39,18 @@
namespace cereal
{
//! \defgroup Archives Input and output archive types
//! \defgroup STLSupport Support for types found in the C++ Standard Library
//! \defgroup OtherTypes Support for miscellaneous types
//! \defgroup Archives Input and Output Archive Types
/*! \defgroup TypeSupport Support for Serializing Various Types
Serialization of many types is shipped with cereal, including most of the standard library as well as a few others. */
/*! \defgroup STLSupport Standard Library Support
Serialization methods for nearly all types found in the C++ standard library
\ingroup TypeSupport */
/*! \defgroup OtherTypes Miscellaneous Types Support
Support for various other types such as smart pointers to polymorphic base classes, boost::variant, etc.
\ingroup TypeSupport */
// ######################################################################
//! An exception class thrown when things go wrong at runtime

View File

@ -1,5 +1,5 @@
/*! \file array.hpp
\brief Support for types found in <array>
\brief Support for types found in \<array\>
\ingroup STLSupport */
/*
Copyright (c) 2013, Randolph Voorhies, Shane Grant

View File

@ -143,7 +143,9 @@ namespace cereal
// If we had chosen to use static_cast<> instead, cereal would perform no tracking and
// assume that every base class should be serialized (in this case leading to a duplicate
// serialization of MyBase due to diamond inheritance
}; */
};
}
@endcode */
template<class Base>
struct virtual_base_class
{

View File

@ -1,5 +1,5 @@
/*! \file bitset.hpp
\brief Support for types found in <bitset>
\brief Support for types found in \<bitset\>
\ingroup STLSupport */
/*
Copyright (c) 2013, Randolph Voorhies, Shane Grant

View File

@ -1,5 +1,5 @@
/*! \file chrono.hpp
\brief Support for types found in <chrono>
\brief Support for types found in \<chrono\>
\ingroup STLSupport */
/*
Copyright (c) 2013, Randolph Voorhies, Shane Grant

View File

@ -1,5 +1,5 @@
/*! \file comples.hpp
\brief Support for types found in <complex>
/*! \file complex.hpp
\brief Support for types found in \<complex\>
\ingroup STLSupport */
/*
Copyright (c) 2013, Randolph Voorhies, Shane Grant

View File

@ -1,5 +1,5 @@
/*! \file deque.hpp
\brief Support for types found in <deque>
\brief Support for types found in \<deque\>
\ingroup STLSupport */
/*
Copyright (c) 2013, Randolph Voorhies, Shane Grant

View File

@ -1,5 +1,5 @@
/*! \file forward_list.hpp
\brief Support for types found in <forward_list>
\brief Support for types found in \<forward_list\>
\ingroup STLSupport */
/*
Copyright (c) 2013, Randolph Voorhies, Shane Grant

View File

@ -1,5 +1,5 @@
/*! \file list.hpp
\brief Support for types found in \<list>
\brief Support for types found in \<list\>
\ingroup STLSupport */
/*
Copyright (c) 2013, Randolph Voorhies, Shane Grant

View File

@ -1,5 +1,5 @@
/*! \file map.hpp
\brief Support for types found in <map>
\brief Support for types found in \<map\>
\ingroup STLSupport */
/*
Copyright (c) 2013, Randolph Voorhies, Shane Grant

View File

@ -1,5 +1,5 @@
/*! \file memory.hpp
\brief Support for types found in <memory>
\brief Support for types found in \<memory\>
\ingroup STLSupport */
/*
Copyright (c) 2013, Randolph Voorhies, Shane Grant

View File

@ -1,5 +1,5 @@
/*! \file queue.hpp
\brief Support for types found in <queue>
\brief Support for types found in \<queue\>
\ingroup STLSupport */
/*
Copyright (c) 2013, Randolph Voorhies, Shane Grant

View File

@ -1,5 +1,5 @@
/*! \file set.hpp
\brief Support for types found in <set>
\brief Support for types found in \<set\>
\ingroup STLSupport */
/*
Copyright (c) 2013, Randolph Voorhies, Shane Grant

View File

@ -1,5 +1,5 @@
/*! \file stack.hpp
\brief Support for types found in <stack>
\brief Support for types found in \<stack\>
\ingroup STLSupport */
/*
Copyright (c) 2013, Randolph Voorhies, Shane Grant

View File

@ -1,5 +1,5 @@
/*! \file string.hpp
\brief Support for types found in <string>
\brief Support for types found in \<string\>
\ingroup STLSupport */
/*
Copyright (c) 2013, Randolph Voorhies, Shane Grant

View File

@ -1,5 +1,5 @@
/*! \file tuple.hpp
\brief Support for types found in <tuple>
\brief Support for types found in \<tuple\>
\ingroup STLSupport */
/*
Copyright (c) 2013, Randolph Voorhies, Shane Grant

View File

@ -1,5 +1,5 @@
/*! \file unordered_map.hpp
\brief Support for types found in <unordered_map>
\brief Support for types found in \<unordered_map\>
\ingroup STLSupport */
/*
Copyright (c) 2013, Randolph Voorhies, Shane Grant

View File

@ -1,5 +1,5 @@
/*! \file unordered_set.hpp
\brief Support for types found in <unordered_set>
\brief Support for types found in \<unordered_set\>
\ingroup STLSupport */
/*
Copyright (c) 2013, Randolph Voorhies, Shane Grant

View File

@ -1,5 +1,5 @@
/*! \file utility.hpp
\brief Support for types found in <utility>
\brief Support for types found in \<utility\>
\ingroup STLSupport */
/*
Copyright (c) 2013, Randolph Voorhies, Shane Grant

View File

@ -1,5 +1,5 @@
/*! \file vector.hpp
\brief Support for types found in <vector>
\brief Support for types found in \<vector\>
\ingroup STLSupport */
/*
Copyright (c) 2013, Randolph Voorhies, Shane Grant