diff options
| author | Dmitri Gribenko <gribozavr@gmail.com> | 2013-04-10 15:35:17 +0000 |
|---|---|---|
| committer | Dmitri Gribenko <gribozavr@gmail.com> | 2013-04-10 15:35:17 +0000 |
| commit | 6fd7d3067dd06584ef3940e88e31fea1a0e83588 (patch) | |
| tree | 30b2a0027f55979566b402c74cd329e8533d324d /docs | |
| parent | 423dd93c8011aa8bca9b761b0b121ea8bce0fd03 (diff) | |
Add an option to parse all comments as documentation comments
Patch by Amin Shali.
git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@179180 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/UsersManual.rst | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/UsersManual.rst b/docs/UsersManual.rst index 6cc836130f..97784f1b1b 100644 --- a/docs/UsersManual.rst +++ b/docs/UsersManual.rst @@ -1005,6 +1005,19 @@ below. If multiple flags are present, the last one is used. Generate complete debug info. +Comment Parsing Options +-------------------------- + +Clang parses Doxygen and non-Doxygen style documentation comments and attaches +them to the appropriate declaration nodes. By default, it only parses +Doxygen-style comments and ignores ordinary comments starting with ``//`` and +``/*``. + +.. option:: -fparse-all-comments + + Parse all comments as documentation comments (including ordinary comments + starting with ``//`` and ``/*``). + .. _c: C Language Features |