Updated the Doxygen docs so that all the core numerics files are in the same

module group.
This commit is contained in:
John Wiegley 2008-08-05 19:49:01 -04:00
parent 36cd816404
commit da6ceaba1a
6 changed files with 31 additions and 1 deletions

View file

@ -523,7 +523,7 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories # directories like "/usr/src/myproject". Separate the files or directories
# with spaces. # with spaces.
INPUT = %srcdir%/src INPUT = %srcdir%/src %srcdir%/test/unit
# This tag can be used to specify the character encoding of the source files # This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is

View file

@ -29,6 +29,10 @@
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/ */
/**
* @defgroup numerics Core numerics
*/
/** /**
* @file amount.h * @file amount.h
* @author John Wiegley * @author John Wiegley
@ -36,6 +40,8 @@
* *
* @brief Basic type for handling commoditized math: amount_t. * @brief Basic type for handling commoditized math: amount_t.
* *
* @ingroup numerics
*
* This file contains the most basic numerical type in Ledger: * This file contains the most basic numerical type in Ledger:
* amount_t, which relies upon commodity.h (commodity_t) for handling * amount_t, which relies upon commodity.h (commodity_t) for handling
* commoditized amounts. This class allows Ledger to handle * commoditized amounts. This class allows Ledger to handle

View file

@ -29,6 +29,10 @@
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/ */
/**
* @defgroup numerics Core numerics
*/
/** /**
* @file balance.h * @file balance.h
* @author John Wiegley * @author John Wiegley
@ -36,6 +40,8 @@
* *
* @brief Basic type for adding multiple commodities together. * @brief Basic type for adding multiple commodities together.
* *
* @ingroup numerics
*
* Unlike the amount_t class, which throws an exception if amounts of * Unlike the amount_t class, which throws an exception if amounts of
* differing commodities are added or subtracted, the balance_t class * differing commodities are added or subtracted, the balance_t class
* is designed to allow this, tracking the amounts of each component * is designed to allow this, tracking the amounts of each component

View file

@ -29,6 +29,10 @@
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/ */
/**
* @defgroup numerics Core numerics
*/
/** /**
* @file balpair.h * @file balpair.h
* @author John Wiegley * @author John Wiegley
@ -36,6 +40,8 @@
* *
* @brief Provides an abstraction around balance_t for tracking costs. * @brief Provides an abstraction around balance_t for tracking costs.
* *
* @ingroup numerics
*
* When a transaction's amount is added to a balance, only the "value" * When a transaction's amount is added to a balance, only the "value"
* of the amount is added -- not the associated cost of the * of the amount is added -- not the associated cost of the
* transaction. To provide for this, the balance_pair_t type allows * transaction. To provide for this, the balance_pair_t type allows

View file

@ -29,6 +29,10 @@
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/ */
/**
* @defgroup numerics Core numerics
*/
/** /**
* @file commodity.h * @file commodity.h
* @author John Wiegley * @author John Wiegley
@ -36,6 +40,8 @@
* *
* @brief Types for handling commodities. * @brief Types for handling commodities.
* *
* @ingroup numerics
*
* This file contains one of the most basic types in Ledger: * This file contains one of the most basic types in Ledger:
* commodity_t, and its annotated cousin, annotated_commodity_t. * commodity_t, and its annotated cousin, annotated_commodity_t.
*/ */

View file

@ -29,6 +29,10 @@
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/ */
/**
* @defgroup numerics Core numerics
*/
/** /**
* @file value.h * @file value.h
* @author John Wiegley * @author John Wiegley
@ -36,6 +40,8 @@
* *
* @brief Abstract dynamic type representing various numeric types. * @brief Abstract dynamic type representing various numeric types.
* *
* @ingroup numerics
*
* A value_t object can be one of many types, and changes its type * A value_t object can be one of many types, and changes its type
* dynamically based on how it is used. For example, if you assign * dynamically based on how it is used. For example, if you assign
* the number 10 to a value object, it's internal type will be * the number 10 to a value object, it's internal type will be