Tweak MCSymbol doxyments.
authorDaniel Dunbar <daniel@zuster.org>
Wed, 1 Jul 2009 07:03:41 +0000 (07:03 +0000)
committerDaniel Dunbar <daniel@zuster.org>
Wed, 1 Jul 2009 07:03:41 +0000 (07:03 +0000)
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@74599 91177308-0d34-0410-b5e6-96231b3b80d8

include/llvm/MC/MCSymbol.h

index a6a9dff5075c46e83faa150bd9b3185207ccfbb3..235e6614f973fb926291dafb66974d6613fbaca1 100644 (file)
@@ -30,8 +30,8 @@ namespace llvm {
   class MCSymbol {
     /// Name - The name of the symbol.
     std::string Name;
-    /// Section - The section the symbol is defined in, or null if not defined
-    /// in this translation unit.
+    /// Section - The section the symbol is defined in, or null if the symbol
+    /// has not been defined in the associated translation unit.
     MCSection *Section;
     
     /// IsTemporary - True if this is an assembler temporary label, which
@@ -39,7 +39,9 @@ namespace llvm {
     /// "Lfoo" or ".foo".
     unsigned IsTemporary : 1;
     
-    /// IsExternal - ?
+    /// IsExternal - True if this symbol has been implicitly defined as an
+    /// external, for example by using it in an expression without ever emitting
+    /// it as a label. The @var Section for an external symbol is always null.
     unsigned IsExternal : 1;
 
   private:  // MCContext creates and uniques these.