Ver código fonte

[AST][NFC] Doc comments for ASTNameGenerator

git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@371112 91177308-0d34-0410-b5e6-96231b3b80d8
Jan Korous 6 anos atrás
pai
commit
1d2ee3f72a
1 arquivos alterados com 8 adições e 0 exclusões
  1. 8 0
      include/clang/AST/Mangle.h

+ 8 - 0
include/clang/AST/Mangle.h

@@ -250,8 +250,16 @@ class ASTNameGenerator {
 public:
 public:
   explicit ASTNameGenerator(ASTContext &Ctx);
   explicit ASTNameGenerator(ASTContext &Ctx);
   ~ASTNameGenerator();
   ~ASTNameGenerator();
+
+  /// Writes name for \p D to \p OS.
+  /// \returns true on failure, false on success.
   bool writeName(const Decl *D, raw_ostream &OS);
   bool writeName(const Decl *D, raw_ostream &OS);
+
+  /// \returns name for \p D
   std::string getName(const Decl *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);
   std::vector<std::string> getAllManglings(const Decl *D);
 
 
 private:
 private: