summaryrefslogtreecommitdiffstats
path: root/llvm/include/llvm-c/lto.h
diff options
context:
space:
mode:
authorGregory Szorc <gregory.szorc@gmail.com>2012-03-21 03:54:29 +0000
committerGregory Szorc <gregory.szorc@gmail.com>2012-03-21 03:54:29 +0000
commit34c863a0312c848a315207188c5503baefc0e41a (patch)
tree4864a20466ed0127965ea709b8c5a255b02d0e19 /llvm/include/llvm-c/lto.h
parent3eb0edde78e57422a0e1856d1085a218368e4635 (diff)
downloadbcm5719-llvm-34c863a0312c848a315207188c5503baefc0e41a.tar.gz
bcm5719-llvm-34c863a0312c848a315207188c5503baefc0e41a.zip
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). llvm-svn: 153157
Diffstat (limited to 'llvm/include/llvm-c/lto.h')
-rw-r--r--llvm/include/llvm-c/lto.h10
1 files changed, 10 insertions, 0 deletions
diff --git a/llvm/include/llvm-c/lto.h b/llvm/include/llvm-c/lto.h
index 7ea7ad01a21..43ef9dcd643 100644
--- a/llvm/include/llvm-c/lto.h
+++ b/llvm/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
OpenPOWER on IntegriCloud