From: Mukund Sivaraman <muks@isc.org>
Date: Fri, 14 Sep 2012 05:25:38 +0000 (+0530)
Subject: [2108] Fix doc comment for InMemoryClient::getFileName()
X-Git-Tag: trac2351_base~70^2~7
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=7f4c06a3fcbbff054ff5227b7b3b60f865b8ed46;p=thirdparty%2Fkea.git

[2108] Fix doc comment for InMemoryClient::getFileName()
---

diff --git a/src/lib/datasrc/memory/memory_client.h b/src/lib/datasrc/memory/memory_client.h
index bff55f4665..dd0058efb2 100644
--- a/src/lib/datasrc/memory/memory_client.h
+++ b/src/lib/datasrc/memory/memory_client.h
@@ -132,14 +132,15 @@ public:
     ///
     /// This method returns the name of the zone's master file to be loaded.
     /// The returned string will be an empty unless the data source client has
-    /// successfully loaded the zone before.
+    /// successfully loaded the \c zone_name zone from a file before.
     ///
     /// This method should normally not throw an exception.  But the creation
     /// of the return string may involve a resource allocation, and if it
     /// fails, the corresponding standard exception will be thrown.
     ///
-    /// \return The name of the zone file loaded in the client, or an empty
-    /// string if the client hasn't loaded any file.
+    /// \return The name of the zone file corresponding to the zone, or
+    /// an empty string if the client hasn't loaded the \c zone_name
+    /// zone from a file before.
     const std::string getFileName(const isc::dns::Name& zone_name) const;
 
     /// \brief Inserts an rrset into the zone.