diff options
| author | Gregory Szorc <gregory.szorc@gmail.com> | 2012-03-21 03:54:29 +0000 |
|---|---|---|
| committer | Gregory Szorc <gregory.szorc@gmail.com> | 2012-03-21 03:54:29 +0000 |
| commit | 6244b518880842f2c15200ee041e06799e4cc779 (patch) | |
| tree | 6ef23df5463f1f0d68da75493b8c7978ee7cc06a /include/llvm-c/lto.h | |
| parent | 9be7c94ccd175c023c10ce3936a6dd374c7a952f (diff) | |
| download | llvm-6244b518880842f2c15200ee041e06799e4cc779.tar.gz llvm-6244b518880842f2c15200ee041e06799e4cc779.tar.bz2 llvm-6244b518880842f2c15200ee041e06799e4cc779.tar.xz | |
Organize LLVM C API docs into doxygen modules; add docs
This gives a lot of love to the docs for the C API. Like Clang's
documentation, the C API is now organized into a Doxygen "module"
(LLVMC). Each C header file is a child of the main module. Some modules
(like Core) have a hierarchy of there own. The produced documentation is
thus better organized (before everything was in one monolithic list).
This patch also includes a lot of new documentation for APIs in Core.h.
It doesn't document them all, but is better than none. Function docs are
missing @param and @return annotation, but the documentation body now
commonly provides help details (like the expected llvm::Value sub-type
to expect).
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@153157 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'include/llvm-c/lto.h')
| -rw-r--r-- | include/llvm-c/lto.h | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/include/llvm-c/lto.h b/include/llvm-c/lto.h index 7ea7ad01a2..43ef9dcd64 100644 --- a/include/llvm-c/lto.h +++ b/include/llvm-c/lto.h @@ -20,6 +20,13 @@ #include <stddef.h> #include <unistd.h> +/** + * @defgroup LLVMCLTO LTO + * @ingroup LLVMC + * + * @{ + */ + #define LTO_API_VERSION 4 typedef enum { @@ -289,5 +296,8 @@ lto_codegen_debug_options(lto_code_gen_t cg, const char *); } #endif +/** + * @} + */ #endif |