[PATCH] Comment parsing: rendering kind field for inline command

headers Dmitri Gribenko | 21 Jul 2012 05:04

On Fri, Jul 20, 2012 at 2:35 PM, Dmitri Gribenko <gribozavr@...> wrote:
> On Fri, Jul 20, 2012 at 9:04 AM, Douglas Gregor <dgregor@...> wrote:
>> Here, we're classifying a subset of the Doxygen inline commands. Can you extract this operation out into
a member function of InlineCommandComment, something like
[...]
>> or maybe tie it to the rendering of the text, e.g.,
>>
>>         enum CXInlineCommandRenderKind {
>>                 ICR_Normal,
>>                 ICR_Bold,
>>                 ICR_Code,
>>                 ICR_Emphasized
>>         }
>>
>>         CXInlineCommandRenderKind getRenderKind() const;
>>
>> so that all clients don't need to reinterpret the various Doxygen/HeaderDoc/etc. commands themselves
(Unless they want to)? This information would be useful in the libclang API as well, since we expect many
clients to use that.
>
> Agreed.  I like the second option better because Doxygen manual
> assigns some semantic difference to the commands which are rendered
> the same way.  For example, \c is "anything that looks like code", but
> \p is "parameter name".
>
> I will do it as a follow-up because I think it makes sense to make
> CommentSema responsible for such analysis and touching that is a
> little out of scope for this patch.

Attached is a patch that implements this proposal.

Please review.

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@...>*/