Organize LLVM C API docs into doxygen modules; add docs
authorGregory Szorc <gregory.szorc@gmail.com>
Wed, 21 Mar 2012 03:54:29 +0000 (03:54 +0000)
committerGregory Szorc <gregory.szorc@gmail.com>
Wed, 21 Mar 2012 03:54:29 +0000 (03:54 +0000)
commit6244b518880842f2c15200ee041e06799e4cc779
tree6ef23df5463f1f0d68da75493b8c7978ee7cc06a
parent9be7c94ccd175c023c10ce3936a6dd374c7a952f
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
16 files changed:
include/llvm-c/Analysis.h
include/llvm-c/BitReader.h
include/llvm-c/BitWriter.h
include/llvm-c/Core.h
include/llvm-c/Disassembler.h
include/llvm-c/EnhancedDisassembly.h
include/llvm-c/ExecutionEngine.h
include/llvm-c/Initialization.h
include/llvm-c/LinkTimeOptimizer.h
include/llvm-c/Object.h
include/llvm-c/Target.h
include/llvm-c/Transforms/IPO.h
include/llvm-c/Transforms/PassManagerBuilder.h
include/llvm-c/Transforms/Scalar.h
include/llvm-c/Transforms/Vectorize.h
include/llvm-c/lto.h