[llvm-commits] [PATCH] Organize LLVM C API docs into doxygen modules; add docs

[Gregory Szorc]

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).
---
 include/llvm-c/Analysis.h                      |   10 +
 include/llvm-c/BitReader.h                     |   10 +
 include/llvm-c/BitWriter.h                     |   10 +
 include/llvm-c/Core.h                          | 1565 ++++++++++++++++++++++--
 include/llvm-c/Disassembler.h                  |   11 +
 include/llvm-c/EnhancedDisassembly.h           |   17 +
 include/llvm-c/ExecutionEngine.h               |   11 +
 include/llvm-c/Initialization.h                |   13 +
 include/llvm-c/LinkTimeOptimizer.h             |   11 +
 include/llvm-c/Object.h                        |   10 +
 include/llvm-c/Target.h                        |   10 +
 include/llvm-c/Transforms/IPO.h                |   11 +
 include/llvm-c/Transforms/PassManagerBuilder.h |   11 +
 include/llvm-c/Transforms/Scalar.h             |   10 +
 include/llvm-c/Transforms/Vectorize.h          |   11 +
 include/llvm-c/lto.h                           |   10 +
 16 files changed, 1622 insertions(+), 109 deletions(-)

---

I'm sure there are common spelling and grammar errors. But, I'm more
concerned that I managed to get the gist of all the APIs correct - I'm
not an expert on the LLVM API or IR.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: 0001-Organize-LLVM-C-API-docs-into-doxygen-modules-add-do.patch
Type: text/x-patch
Size: 78267 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20120312/8d0c7e80/attachment.bin>