[cfe-dev] libclang based doxygen replacement

[don hinton]

On Aug 16, 2012, at 16:36, Douglas Gregor <dgregor at apple.com> wrote:

> 
> On Aug 16, 2012, at 2:03 PM, don hinton <hintonda at gmail.com> wrote:
> 
>> Hi Doug:
>> 
>> On Aug 15, 2012, at 23:26, Douglas Gregor <dgregor at apple.com> wrote:
>> 
>>> 
>>> On Aug 15, 2012, at 6:29 PM, don hinton <don.hinton at gmx.com> wrote:
>>> 
>>>> Hi:
>>>> 
>>>> I've written a small prototype of a doxygen-like program based on libclang with the hope of eventually contributing it.  
>>>> 
>>>> I've only just started using clang, so I was hoping I could share what I've got so far and get feedback from more experienced clang developers before moving to the next phase.
>>>> 
>>>> Currently, it generates an html page for each source file, a la doxygen,, with intra- and inter-file links for variables, functions, and classes/structs.  There are still some rough edges, but I wanted to make sure I was using the libclang API correctly before moving on to the documentation pages.
>>> 
>>> 
>>> I think there are a number of people here who are interested in such a tool. If it's too large to send in as a patch or just as source, you might consider making it available on GitHub or similar, so that you can get more feedback from other interested developers and users.
>>> 
>>> I'm not sure how closely you're following top-of-tree Clang, but Dmitri Gribenko has been adding Doxygen comment parsing support to Clang (including adding it to libclang), which makes it a heck of a lot easier to build a Doxygen replacement than it used to be.
>>> 
>> 
>> I've been mainly working off the 3.1 version in ports, but did link against the head a few times.  I think the comment work you mentioned is in both, but I'll refresh, rebuild, and test against the head too.
> 
> 
> All of Dmitri's work occurred long after Clang 3.1. To use any of it, you'll need to use the latest (lib)clang directly from Subversion. For reference, here are the libclang APIs he has introduced:
> 

Perfect, thanks..

>    http://clang.llvm.org/doxygen/group__CINDEX__COMMENT.html
> 
>    - Doug