[cfe-dev] [GSoC] Doxygen documentation with clang

[Dmitri Gribenko]

On Wed, Mar 5, 2014 at 8:22 PM, Jonathan 'Rynn' Sauer
<jonathan.sauer at gmx.de> wrote:
> Hello,
>
>> one of the project ideas for GSoC 2014 is a clang-based tool to
>> generate documentation using doxygen-style comments in the source
>> code.  I wanted to gauge the interest into such a project, see if
>> someone is willing to mentor it, and provide a rough outline of what
>> my idea of the project is. Any feedback on this is very welcome.
>
> This project sounds very interesting and definitely useful; "clang-doc" in addition
> to clang-format and the static analyzer.
>
> A few points:
>
> 1. Doxygen offers the possibility to define custom commands in its config file[1]. I am
>    using this in my code to document the bindings to the scripting language Lua, i.e.
>    @luaparam to document a parameter and @luareturn to document a return value. AFAIK
>    clang currently does not support custom commands and warns about their use (unless
>    -Wno-documentation-unknown-command is specified).

Note that Clang supports -fcomment-block-commands= parameter, which
allows us to get the correct AST for custom commands.  I think this
should also silence the warning.

Dmitri

-- 
main(i,j){for(i=2;;i++){for(j=2;j<i;j++){if(!(i%j)){j=0;break;}}if
(j){printf("%d\n",i);}}} /*Dmitri Gribenko <gribozavr at gmail.com>*/