[cfe-dev] RFC: clang-doc proposal
Sam McCall via cfe-dev
cfe-dev at lists.llvm.org
Tue Dec 5 01:48:40 PST 2017
On Mon, Dec 4, 2017 at 9:21 PM, Julie Hockett via cfe-dev <
cfe-dev at lists.llvm.org> wrote:
> Since a good deal of existing C/C++ code uses the Doxygen documentation
> comment style, which is also supported by Clang's parser (and Doxygen
> itself can use Clang to parse these comments), this is the syntax we are
> going to support as well. In the future, we would also like to support
> Markdown-style comments, akin to Apple Swift Markup.
Needless to say, a good deal of existing C/C++ code does not use the
Doxygen documentation comment style, or any other explicit markup style.
Additionally, doxygen (and similar things like Javadoc) sacrifice some
readability of the comments for the documentation.
For these reasons, it'd be great to have first-class support for "plain"
comments. (Even though it's a hard problem)
-------------- next part --------------
An HTML attachment was scrubbed...
More information about the cfe-dev