BIND 10 trac2138, updated. f02efa83ef95d63d9a0f82a4806b748340cf112c [2138] added suggested revised doc for AuthCommand::exec().

[BIND 10 source code commits]

The branch, trac2138 has been updated
       via  f02efa83ef95d63d9a0f82a4806b748340cf112c (commit)
      from  c286d6ae6a08691226122bee5cf5ce86aeac723e (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.

- Log -----------------------------------------------------------------
commit f02efa83ef95d63d9a0f82a4806b748340cf112c
Author: JINMEI Tatuya <jinmei at isc.org>
Date:   Tue Aug 21 10:38:13 2012 -0700

    [2138] added suggested revised doc for AuthCommand::exec().

-----------------------------------------------------------------------

Summary of changes:
 src/bin/auth/command.cc |    9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

-----------------------------------------------------------------------
diff --git a/src/bin/auth/command.cc b/src/bin/auth/command.cc
index 76de6c2..225f581 100644
--- a/src/bin/auth/command.cc
+++ b/src/bin/auth/command.cc
@@ -98,9 +98,16 @@ public:
     /// \c AuthCommandError when it encounters an internal error, such as
     /// semantics error on the command arguments.
     ///
+    /// This method should return the execution result in the form of
+    /// \c ConstElementPtr.  It will be transparently used as the return
+    /// value from the command handler called from the corresponding
+    /// \c CCSession object.  For a successful completion of the command,
+    /// it should suffice to return the return value of
+    /// \c isc::config::createAnswer() with no argument.
+    ///
     /// \param server The \c AuthSrv object on which the command is executed.
     /// \param args Command specific argument.
-    /// \return command result using createAnswer().
+    /// \return Command execution result.
     virtual ConstElementPtr exec(AuthSrv& server,
                                  isc::data::ConstElementPtr args) = 0;
 };