<p dir="ltr">Yeah, we should be doing this. Nice catch Paul and Greg. </p>
<br><div class="gmail_quote"><div dir="ltr">On Tue, Feb 23, 2016, 10:34 PM Greg Bedwell <<a href="mailto:greg_bedwell@sn.scee.net">greg_bedwell@sn.scee.net</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">gbedwell added a subscriber: gbedwell.<br>
gbedwell added a comment.<br>
<br>
In <a href="http://reviews.llvm.org/D17550#360177" rel="noreferrer" target="_blank">http://reviews.llvm.org/D17550#360177</a>, @probinson wrote:<br>
<br>
> One question I have, which shouldn't block this (as we've done several like this already):<br>
>  Is is okay to be using C++ style comments in these headers?<br>
>  (Is there a C-style comment that Doxygen recognizes?)<br>
<br>
<br>
There are a few various formats that Doxygen supports.  Looking at headers from llvm-c the most common convention appears to be JavaDoc style, although there are a few examples of other supported styles floating around the codebase.  E.g. from include/llvm-c/lto.h using JavaDoc style:<br>
<br>
/**<br>
<br>
- Diagnostic handler type.<br>
- \p severity defines the severity.<br>
- \p diag is the actual diagnostic.<br>
- The diagnostic is not prefixed by any of severity keyword, e.g., 'error: '.<br>
- \p ctxt is used to pass the context set with the diagnostic handler. *<br>
- \since LTO_API_VERSION=7 */<br>
<br>
-Greg<br>
<br>
<br>
Repository:<br>
  rL LLVM<br>
<br>
<a href="http://reviews.llvm.org/D17550" rel="noreferrer" target="_blank">http://reviews.llvm.org/D17550</a><br>
<br>
<br>
<br>
</blockquote></div>