diff options
| author | Dmitri Gribenko <gribozavr@gmail.com> | 2012-07-21 01:47:43 +0000 |
|---|---|---|
| committer | Dmitri Gribenko <gribozavr@gmail.com> | 2012-07-21 01:47:43 +0000 |
| commit | 3e63d332baf0d3b8a5c0b7c2dac2ae85615b1d47 (patch) | |
| tree | df70d3956695d9b917e345d4209c141077b144b4 /include/clang-c | |
| parent | d256f8673bf2499f57e0f40aab30ff243d576c17 (diff) | |
Comment to HTML conversion: add more CSS classes to identify function arguments
by index. This is useful if the user does not document all arguments, and we
can't find a particular argument by index via :nth-of-type() CSS selector.
git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@160595 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'include/clang-c')
| -rw-r--r-- | include/clang-c/Index.h | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/include/clang-c/Index.h b/include/clang-c/Index.h index d95f010a6f..93a522457e 100644 --- a/include/clang-c/Index.h +++ b/include/clang-c/Index.h @@ -3563,8 +3563,12 @@ CINDEX_LINKAGE CXString clang_HTMLTagComment_getAsString(CXComment Comment); * \li "para-returns" for \\returns paragraph and equivalent commands; * \li "word-returns" for the "Returns" word in \\returns paragraph. * - * Argument list is rendered as \<dl\> list with arguments sorted in function - * prototype order. + * Function argument documentation is rendered as a \<dl\> list with arguments + * sorted in function prototype order. CSS classes used: + * \li "param-name-index-NUMBER" for parameter name (\<dt\>); + * \li "param-descr-index-NUMBER" for parameter description (\<dd\>); + * \li "param-name-index-invalid" and "param-descr-index-invalid" are used if + * parameter index is invalid. * * \param Comment a \c CXComment_FullComment AST node. * |