summaryrefslogtreecommitdiffstats
path: root/libdimension/dimension/inline.h
diff options
context:
space:
mode:
authorTavian Barnes <tavianator@gmail.com>2010-11-14 21:20:43 -0500
committerTavian Barnes <tavianator@gmail.com>2010-11-14 21:20:43 -0500
commit8fe33a340b8979a73fa84f201c15519a9b5d0266 (patch)
tree12cdbb1c1b9a48f533ab36980602785be1e1deeb /libdimension/dimension/inline.h
parent20a55aa78050d94b187d4edfaac91ea00efea505 (diff)
downloaddimension-8fe33a340b8979a73fa84f201c15519a9b5d0266.tar.xz
Document libdimension with Doxygen.
Diffstat (limited to 'libdimension/dimension/inline.h')
-rw-r--r--libdimension/dimension/inline.h16
1 files changed, 11 insertions, 5 deletions
diff --git a/libdimension/dimension/inline.h b/libdimension/dimension/inline.h
index edf92b1..4f12c28 100644
--- a/libdimension/dimension/inline.h
+++ b/libdimension/dimension/inline.h
@@ -18,16 +18,22 @@
* <http://www.gnu.org/licenses/>. *
*************************************************************************/
-/*
- * Handle inlines nicely without cheating and making them static. The
- * DMNSN_INLINE macro is set appropriately for the version of C you're using,
- * and non-inline versions are emitted in exactly one translation unit when
- * necessary.
+/**
+ * @file
+ * Inline function support. Handle inlines nicely without cheating and making
+ * them static. The DMNSN_INLINE macro is set appropriately for the version of
+ * C you're using, and non-inline versions are emitted in exactly one
+ * translation unit when necessary.
*/
#ifndef DIMENSION_INLINE_H
#define DIMENSION_INLINE_H
+/**
+ * @def DMNSN_INLINE
+ * A portable inline specifier. Expands to the correct method of declaring
+ * inline functions for the version of C you are using.
+ */
#ifndef DMNSN_INLINE
#ifdef __cplusplus
/* C++ inline semantics */