[cfe-commits] [PATCH] CommentBriefParser: use \returns as a last resort

Douglas Gregor dgregor at apple.com
Fri Jul 20 08:37:52 PDT 2012


On Jul 19, 2012, at 2:56 PM, Dmitri Gribenko <gribozavr at gmail.com> wrote:

> Hello,
> 
> The attached patch makes CommentBriefParser use \returns if it can't
> find the \brief or just a plain paragraph.

LGTM!

> I'm not sure whether to prepend "Returns" to extracted text or not.
> In most cases this would be appropriate, but in some (rare) cases
> documentation is written in languages other than English.


Clang, and most tools built upon it, just don't deal with non-English languages well at all. I think the best course of action is to prepend "Returns" and, if/when someone wants to really deal with non-English language issues, this should be one of the easier things to tackle.

	- Doug



More information about the cfe-commits mailing list