r299650 - Avoid the -Wdocumentation-unknown-command warning in Clang's C API docs

Alex Lorenz via cfe-commits cfe-commits at lists.llvm.org
Thu Apr 6 07:03:25 PDT 2017


Author: arphaman
Date: Thu Apr  6 09:03:25 2017
New Revision: 299650

URL: http://llvm.org/viewvc/llvm-project?rev=299650&view=rev
Log:
Avoid the -Wdocumentation-unknown-command warning in Clang's C API docs

rdar://20441985

Modified:
    cfe/trunk/include/clang-c/Index.h

Modified: cfe/trunk/include/clang-c/Index.h
URL: http://llvm.org/viewvc/llvm-project/cfe/trunk/include/clang-c/Index.h?rev=299650&r1=299649&r2=299650&view=diff
==============================================================================
--- cfe/trunk/include/clang-c/Index.h (original)
+++ cfe/trunk/include/clang-c/Index.h Thu Apr  6 09:03:25 2017
@@ -4034,8 +4034,8 @@ CINDEX_LINKAGE unsigned clang_Cursor_get
 
 /**
  * \brief Given a cursor that represents an Objective-C method or property
- * declaration, return non-zero if the declaration was affected by "@optional".
- * Returns zero if the cursor is not such a declaration or it is "@required".
+ * declaration, return non-zero if the declaration was affected by "\@optional".
+ * Returns zero if the cursor is not such a declaration or it is "\@required".
  */
 CINDEX_LINKAGE unsigned clang_Cursor_isObjCOptional(CXCursor C);
 
@@ -4711,7 +4711,7 @@ enum CXCompletionChunkKind {
    */
   CXCompletionChunk_HorizontalSpace,
   /**
-   * Vertical space ('\n'), after which it is generally a good idea to
+   * Vertical space ('\\n'), after which it is generally a good idea to
    * perform indentation.
    */
   CXCompletionChunk_VerticalSpace




More information about the cfe-commits mailing list