r371112 - [AST][NFC] Doc comments for ASTNameGenerator

Jan Korous via cfe-commits cfe-commits at lists.llvm.org
Thu Sep 5 13:04:12 PDT 2019


Author: jkorous
Date: Thu Sep  5 13:04:11 2019
New Revision: 371112

URL: http://llvm.org/viewvc/llvm-project?rev=371112&view=rev
Log:
[AST][NFC] Doc comments for ASTNameGenerator

Modified:
    cfe/trunk/include/clang/AST/Mangle.h

Modified: cfe/trunk/include/clang/AST/Mangle.h
URL: http://llvm.org/viewvc/llvm-project/cfe/trunk/include/clang/AST/Mangle.h?rev=371112&r1=371111&r2=371112&view=diff
==============================================================================
--- cfe/trunk/include/clang/AST/Mangle.h (original)
+++ cfe/trunk/include/clang/AST/Mangle.h Thu Sep  5 13:04:11 2019
@@ -250,8 +250,16 @@ class ASTNameGenerator {
 public:
   explicit ASTNameGenerator(ASTContext &Ctx);
   ~ASTNameGenerator();
+
+  /// Writes name for \p D to \p OS.
+  /// \returns true on failure, false on success.
   bool writeName(const Decl *D, raw_ostream &OS);
+
+  /// \returns name for \p D
   std::string getName(const Decl *D);
+
+  /// \returns all applicable mangled names.
+  /// For example C++ constructors/destructors can have multiple.
   std::vector<std::string> getAllManglings(const Decl *D);
 
 private:




More information about the cfe-commits mailing list