From 940a273768b4c13f27e9582987604701deb6e495 Mon Sep 17 00:00:00 2001 From: James Dennett Date: Sun, 17 Jun 2012 04:04:08 +0000 Subject: [PATCH] Documentation cleanup: escaping # characters and adding \brief markup git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@158626 91177308-0d34-0410-b5e6-96231b3b80d8 --- include/clang/Basic/SourceManagerInternals.h | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/include/clang/Basic/SourceManagerInternals.h b/include/clang/Basic/SourceManagerInternals.h index edb43af223..0ef0ee2de3 100644 --- a/include/clang/Basic/SourceManagerInternals.h +++ b/include/clang/Basic/SourceManagerInternals.h @@ -42,7 +42,7 @@ struct LineEntry { /// 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 @@ inline bool operator<(unsigned Offset, const LineEntry &E) { } /// 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 FilenameIDs; std::vector*> 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 > LineEntries; public: LineTableInfo() { -- 2.40.0