[AST][NFC] Doc comments for ASTNameGenerator
authorJan Korous <jkorous@apple.com>
Thu, 5 Sep 2019 20:04:11 +0000 (20:04 +0000)
committerJan Korous <jkorous@apple.com>
Thu, 5 Sep 2019 20:04:11 +0000 (20:04 +0000)
llvm-svn: 371112

clang/include/clang/AST/Mangle.h

index 1362756..e3c95dd 100644 (file)
@@ -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: