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

[Gregory Szorc]

Committed r153157
        M       include/llvm-c/ExecutionEngine.h
        M       include/llvm-c/BitWriter.h
        M       include/llvm-c/Disassembler.h
        M       include/llvm-c/lto.h
        M       include/llvm-c/LinkTimeOptimizer.h
        M       include/llvm-c/BitReader.h
        M       include/llvm-c/Analysis.h
        M       include/llvm-c/EnhancedDisassembly.h
        M       include/llvm-c/Object.h
        M       include/llvm-c/Target.h
        M       include/llvm-c/Initialization.h
        M       include/llvm-c/Core.h
        M       include/llvm-c/Transforms/Vectorize.h
        M       include/llvm-c/Transforms/Scalar.h
        M       include/llvm-c/Transforms/IPO.h
        M       include/llvm-c/Transforms/PassManagerBuilder.h

On 3/20/2012 12:04 PM, Bill Wendling wrote:
> TL;DR. But the patch in general seems okay to me.
> 
> -bw
> 
> On Mar 20, 2012, at 10:07 AM, Gregory Szorc wrote:
> 
>> Ping?
>>
>> On 3/12/12 12:21 AM, Gregory Szorc wrote:
>>> 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.
>>>
>>>
>>>
>>> _______________________________________________
>>> llvm-commits mailing list
>>> llvm-commits at cs.uiuc.edu
>>> http://lists.cs.uiuc.edu/mailman/listinfo/llvm-commits
>>
>>
>> _______________________________________________
>> llvm-commits mailing list
>> llvm-commits at cs.uiuc.edu
>> http://lists.cs.uiuc.edu/mailman/listinfo/llvm-commits