llvm/include/llvm-c
Gregory Szorc 6244b51888 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
2012-03-21 03:54:29 +00:00
..
Transforms Organize LLVM C API docs into doxygen modules; add docs 2012-03-21 03:54:29 +00:00
Analysis.h Organize LLVM C API docs into doxygen modules; add docs 2012-03-21 03:54:29 +00:00
BitReader.h Organize LLVM C API docs into doxygen modules; add docs 2012-03-21 03:54:29 +00:00
BitWriter.h Organize LLVM C API docs into doxygen modules; add docs 2012-03-21 03:54:29 +00:00
Core.h Organize LLVM C API docs into doxygen modules; add docs 2012-03-21 03:54:29 +00:00
Disassembler.h Organize LLVM C API docs into doxygen modules; add docs 2012-03-21 03:54:29 +00:00
EnhancedDisassembly.h Organize LLVM C API docs into doxygen modules; add docs 2012-03-21 03:54:29 +00:00
ExecutionEngine.h Organize LLVM C API docs into doxygen modules; add docs 2012-03-21 03:54:29 +00:00
Initialization.h Organize LLVM C API docs into doxygen modules; add docs 2012-03-21 03:54:29 +00:00
LinkTimeOptimizer.h Organize LLVM C API docs into doxygen modules; add docs 2012-03-21 03:54:29 +00:00
lto.h Organize LLVM C API docs into doxygen modules; add docs 2012-03-21 03:54:29 +00:00
Object.h Organize LLVM C API docs into doxygen modules; add docs 2012-03-21 03:54:29 +00:00
Target.h Organize LLVM C API docs into doxygen modules; add docs 2012-03-21 03:54:29 +00:00