]> granicus.if.org Git - clang/commitdiff
Documentation cleanup:
authorJames Dennett <jdennett@google.com>
Fri, 22 Jun 2012 05:37:13 +0000 (05:37 +0000)
committerJames Dennett <jdennett@google.com>
Fri, 22 Jun 2012 05:37:13 +0000 (05:37 +0000)
* Use \p param for a parameter reference, not the (erroneous) form \arg param;
* Escape # characters in Doxygen comments as needed.

git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@158971 91177308-0d34-0410-b5e6-96231b3b80d8

lib/Lex/PreprocessingRecord.cpp

index 89d19fd52adc42dec0ad378fb5f1297745a1d44b..dfdeba3f9cd961d4f5c26f67c9a5bb6be77f0abf 100644 (file)
@@ -48,7 +48,7 @@ PreprocessingRecord::PreprocessingRecord(SourceManager &SM,
 }
 
 /// \brief Returns a pair of [Begin, End) iterators of preprocessed entities
-/// that source range \arg R encompasses.
+/// that source range \p Range encompasses.
 std::pair<PreprocessingRecord::iterator, PreprocessingRecord::iterator>
 PreprocessingRecord::getPreprocessedEntitiesInRange(SourceRange Range) {
   if (Range.isInvalid())
@@ -89,7 +89,7 @@ static bool isPreprocessedEntityIfInFileID(PreprocessedEntity *PPE, FileID FID,
 ///
 /// Can be used to avoid implicit deserializations of preallocated
 /// preprocessed entities if we only care about entities of a specific file
-/// and not from files #included in the range given at
+/// and not from files \#included in the range given at
 /// \see getPreprocessedEntitiesInRange.
 bool PreprocessingRecord::isEntityInFileID(iterator PPEI, FileID FID) {
   if (FID.isInvalid())