[cfe-commits] r158626 - /cfe/trunk/include/clang/Basic/SourceManagerInternals.h

[James Dennett]

Author: jdennett
Date: Sat Jun 16 23:04:08 2012
New Revision: 158626

URL: http://llvm.org/viewvc/llvm-project?rev=158626&view=rev
Log:
Documentation cleanup: escaping # characters and adding \brief markup

Modified:
    cfe/trunk/include/clang/Basic/SourceManagerInternals.h

Modified: cfe/trunk/include/clang/Basic/SourceManagerInternals.h
URL: http://llvm.org/viewvc/llvm-project/cfe/trunk/include/clang/Basic/SourceManagerInternals.h?rev=158626&r1=158625&r2=158626&view=diff
==============================================================================
--- cfe/trunk/include/clang/Basic/SourceManagerInternals.h (original)
+++ cfe/trunk/include/clang/Basic/SourceManagerInternals.h Sat Jun 16 23:04:08 2012
@@ -42,7 +42,7 @@
 
   /// IncludeOffset - This is the offset of the virtual include stack location,
   /// which is manipulated by GNU linemarker directives.  If this is 0 then
-  /// there is no virtual #includer.
+  /// there is no virtual \#includer.
   unsigned IncludeOffset;
 
   static LineEntry get(unsigned Offs, unsigned Line, int Filename,
@@ -73,18 +73,18 @@
 }
 
 /// LineTableInfo - This class is used to hold and unique data used to
-/// represent #line information.
+/// represent \#line information.
 class LineTableInfo {
   /// FilenameIDs - This map is used to assign unique IDs to filenames in
-  /// #line directives.  This allows us to unique the filenames that
+  /// \#line directives.  This allows us to unique the filenames that
   /// frequently reoccur and reference them with indices.  FilenameIDs holds
   /// the mapping from string -> ID, and FilenamesByID holds the mapping of ID
   /// to string.
   llvm::StringMap<unsigned, llvm::BumpPtrAllocator> FilenameIDs;
   std::vector<llvm::StringMapEntry<unsigned>*> FilenamesByID;
 
-  /// LineEntries - This is a map from FileIDs to a list of line entries (sorted
-  /// by the offset they occur in the file.
+  /// \brief Map from FileIDs to a list of line entries (sorted by the offset
+  /// at which they occur in the file).
   std::map<FileID, std::vector<LineEntry> > LineEntries;
 public:
   LineTableInfo() {