]> granicus.if.org Git - clang/commit
More doxygen/documentation cleanups.
authorJames Dennett <jdennett@google.com>
Wed, 13 Jun 2012 22:07:09 +0000 (22:07 +0000)
committerJames Dennett <jdennett@google.com>
Wed, 13 Jun 2012 22:07:09 +0000 (22:07 +0000)
commit809d1be9820039b4cf6efa48246a0d70ffa13394
treedd2a3d5ac8ce7729f0ecf9b4fc01c6c3a60d14db
parent4ef2f6a95146423a1947b98458cc95c00a8b3ebd
More doxygen/documentation cleanups.

This reduces the number of warnings generated by Doxygen by about 100
(roughly 10%).  Issues addressed:
(1) Primarily, backslash-escaped "@foo" and "#bah" in Doxygen comments
when they're not supposed to be Doxygen commands or links, and
similarly for "<baz>" when it's not intended as as HTML tag;
(2) Changed some \t commands (which don't exist) to \c ("to refer to a
word of code", as the Doxygen manual says);
(3) \precondition becomes \pre;
(4) When touching comments, deleted a couple of spurious spaces in them;
(5) Changed some \n and \r to \\n and \\r;
(6) Fixed one tiny typo: #pragms -> #pragma.

This patch touches documentation/comments only.

git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@158422 91177308-0d34-0410-b5e6-96231b3b80d8
26 files changed:
include/clang/AST/ASTContext.h
include/clang/AST/ExprCXX.h
include/clang/AST/ExprObjC.h
include/clang/AST/StmtObjC.h
include/clang/AST/Type.h
include/clang/Basic/MacroBuilder.h
include/clang/Basic/SourceManager.h
include/clang/Basic/SourceManagerInternals.h
include/clang/Frontend/FrontendOptions.h
include/clang/Frontend/HeaderSearchOptions.h
include/clang/Frontend/PreprocessorOutputOptions.h
include/clang/Lex/CodeCompletionHandler.h
include/clang/Lex/HeaderSearch.h
include/clang/Lex/PPCallbacks.h
include/clang/Lex/Pragma.h
include/clang/Lex/PreprocessingRecord.h
include/clang/Lex/Preprocessor.h
include/clang/Lex/PreprocessorLexer.h
include/clang/Sema/CodeCompleteConsumer.h
include/clang/Sema/Scope.h
include/clang/Sema/ScopeInfo.h
include/clang/Sema/Sema.h
include/clang/Sema/Weak.h
include/clang/Serialization/ASTBitCodes.h
lib/CodeGen/CGObjCGNU.cpp
lib/Frontend/InitPreprocessor.cpp