summaryrefslogtreecommitdiff
path: root/include/llvm-c/Initialization.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
commit6244b518880842f2c15200ee041e06799e4cc779 (patch)
tree6ef23df5463f1f0d68da75493b8c7978ee7cc06a /include/llvm-c/Initialization.h
parent9be7c94ccd175c023c10ce3936a6dd374c7a952f (diff)
downloadllvm-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/Initialization.h')
-rw-r--r--include/llvm-c/Initialization.h13
1 files changed, 13 insertions, 0 deletions
diff --git a/include/llvm-c/Initialization.h b/include/llvm-c/Initialization.h
index cbe60df908..cb3ab9e3f3 100644
--- a/include/llvm-c/Initialization.h
+++ b/include/llvm-c/Initialization.h
@@ -22,6 +22,15 @@
extern "C" {
#endif
+/**
+ * @defgroup LLVMCInitialization Initialization Routines
+ * @ingroup LLVMC
+ *
+ * This module contains routines used to initialize the LLVM system.
+ *
+ * @{
+ */
+
void LLVMInitializeCore(LLVMPassRegistryRef R);
void LLVMInitializeTransformUtils(LLVMPassRegistryRef R);
void LLVMInitializeScalarOpts(LLVMPassRegistryRef R);
@@ -34,6 +43,10 @@ void LLVMInitializeIPA(LLVMPassRegistryRef R);
void LLVMInitializeCodeGen(LLVMPassRegistryRef R);
void LLVMInitializeTarget(LLVMPassRegistryRef R);
+/**
+ * @}
+ */
+
#ifdef __cplusplus
}
#endif