MC: Tidy up comments and clean up formatting a bit. NFC.
[oota-llvm.git] / include / llvm / MC / MCParser / MCAsmParser.h
index 7dcefdb9892d8bac00064580727671fe5e656457..0538b9457f9ebc72d35ec9271d4cba72e8307191 100644 (file)
@@ -45,7 +45,7 @@ public:
   }
 };
 
-/// Generic Sema callback for assembly parser.
+/// \brief Generic Sema callback for assembly parser.
 class MCAsmParserSemaCallback {
 public:
   virtual ~MCAsmParserSemaCallback();
@@ -59,8 +59,8 @@ public:
                                     unsigned &Offset) = 0;
 };
 
-/// Generic assembler parser interface, for use by target specific assembly
-/// parsers.
+/// \brief Generic assembler parser interface, for use by target specific
+/// assembly parsers.
 class MCAsmParser {
 public:
   typedef bool (*DirectiveHandler)(MCAsmParserExtension*, StringRef, SMLoc);
@@ -95,7 +95,7 @@ public:
 
   virtual MCContext &getContext() = 0;
 
-  /// Return the output streamer for the assembler.
+  /// \brief Return the output streamer for the assembler.
   virtual MCStreamer &getStreamer() = 0;
 
   MCTargetAsmParser &getTargetParser() const { return *TargetParser; }
@@ -107,13 +107,13 @@ public:
   bool getShowParsedOperands() const { return ShowParsedOperands; }
   void setShowParsedOperands(bool Value) { ShowParsedOperands = Value; }
 
-  /// Run the parser on the input source buffer.
+  /// \brief Run the parser on the input source buffer.
   virtual bool Run(bool NoInitialTextSection, bool NoFinalize = false) = 0;
 
   virtual void setParsingInlineAsm(bool V) = 0;
   virtual bool isParsingInlineAsm() = 0;
 
-  /// Parse ms-style inline assembly.
+  /// \brief Parse MS-style inline assembly.
   virtual bool parseMSInlineAsm(
       void *AsmLoc, std::string &AsmString, unsigned &NumOutputs,
       unsigned &NumInputs, SmallVectorImpl<std::pair<void *, bool>> &OpDecls,
@@ -121,35 +121,35 @@ public:
       SmallVectorImpl<std::string> &Clobbers, const MCInstrInfo *MII,
       const MCInstPrinter *IP, MCAsmParserSemaCallback &SI) = 0;
 
-  /// Emit a note at the location \p L, with the message \p Msg.
+  /// \brief Emit a note at the location \p L, with the message \p Msg.
   virtual void Note(SMLoc L, const Twine &Msg,
                     ArrayRef<SMRange> Ranges = None) = 0;
 
-  /// Emit a warning at the location \p L, with the message \p Msg.
+  /// \brief Emit a warning at the location \p L, with the message \p Msg.
   ///
   /// \return The return value is true, if warnings are fatal.
   virtual bool Warning(SMLoc L, const Twine &Msg,
                        ArrayRef<SMRange> Ranges = None) = 0;
 
-  /// Emit an error at the location \p L, with the message \p Msg.
+  /// \brief Emit an error at the location \p L, with the message \p Msg.
   ///
   /// \return The return value is always true, as an idiomatic convenience to
   /// clients.
   virtual bool Error(SMLoc L, const Twine &Msg,
                      ArrayRef<SMRange> Ranges = None) = 0;
 
-  /// Get the next AsmToken in the stream, possibly handling file inclusion
-  /// first.
+  /// \brief Get the next AsmToken in the stream, possibly handling file
+  /// inclusion first.
   virtual const AsmToken &Lex() = 0;
 
-  /// Get the current AsmToken from the stream.
+  /// \brief Get the current AsmToken from the stream.
   const AsmToken &getTok() const;
 
   /// \brief Report an error at the current lexer location.
   bool TokError(const Twine &Msg, ArrayRef<SMRange> Ranges = None);
 
-  /// Parse an identifier or string (as a quoted identifier) and set \p Res to
-  /// the identifier contents.
+  /// \brief Parse an identifier or string (as a quoted identifier) and set \p
+  /// Res to the identifier contents.
   virtual bool parseIdentifier(StringRef &Res) = 0;
 
   /// \brief Parse up to the end of statement and return the contents from the
@@ -157,51 +157,51 @@ public:
   /// will be either the EndOfStatement or EOF.
   virtual StringRef parseStringToEndOfStatement() = 0;
 
-  /// Parse the current token as a string which may include escaped characters
-  /// and return the string contents.
+  /// \brief Parse the current token as a string which may include escaped
+  /// characters and return the string contents.
   virtual bool parseEscapedString(std::string &Data) = 0;
 
-  /// Skip to the end of the current statement, for error recovery.
+  /// \brief Skip to the end of the current statement, for error recovery.
   virtual void eatToEndOfStatement() = 0;
 
-  /// Parse an arbitrary expression.
+  /// \brief Parse an arbitrary expression.
   ///
-  /// @param Res - The value of the expression. The result is undefined
+  /// \param Res - The value of the expression. The result is undefined
   /// on error.
-  /// @result - False on success.
+  /// \return - False on success.
   virtual bool parseExpression(const MCExpr *&Res, SMLoc &EndLoc) = 0;
   bool parseExpression(const MCExpr *&Res);
 
-  /// Parse a primary expression.
+  /// \brief Parse a primary expression.
   ///
-  /// @param Res - The value of the expression. The result is undefined
+  /// \param Res - The value of the expression. The result is undefined
   /// on error.
-  /// @result - False on success.
+  /// \return - False on success.
   virtual bool parsePrimaryExpr(const MCExpr *&Res, SMLoc &EndLoc) = 0;
 
-  /// Parse an arbitrary expression, assuming that an initial '(' has already
-  /// been consumed.
+  /// \brief Parse an arbitrary expression, assuming that an initial '(' has
+  /// already been consumed.
   ///
-  /// @param Res - The value of the expression. The result is undefined
+  /// \param Res - The value of the expression. The result is undefined
   /// on error.
-  /// @result - False on success.
+  /// \return - False on success.
   virtual bool parseParenExpression(const MCExpr *&Res, SMLoc &EndLoc) = 0;
 
-  /// Parse an expression which must evaluate to an absolute value.
+  /// \brief Parse an expression which must evaluate to an absolute value.
   ///
-  /// @param Res - The value of the absolute expression. The result is undefined
+  /// \param Res - The value of the absolute expression. The result is undefined
   /// on error.
-  /// @result - False on success.
+  /// \return - False on success.
   virtual bool parseAbsoluteExpression(int64_t &Res) = 0;
 
-  /// Ensure that we have a valid section set in the streamer. Otherwise, report
-  /// an error and switch to .text.
+  /// \brief Ensure that we have a valid section set in the streamer. Otherwise,
+  /// report an error and switch to .text.
   virtual void checkForValidSection() = 0;
 };
 
 /// \brief Create an MCAsmParser instance.
-MCAsmParser *createMCAsmParser(SourceMgr &, MCContext &,
-                               MCStreamer &, const MCAsmInfo &);
+MCAsmParser *createMCAsmParser(SourceMgr &, MCContext &, MCStreamer &,
+                               const MCAsmInfo &);
 
 } // End llvm namespace