Browse Source

update comment and documentation

Jelte Jansen 14 years ago
parent
commit
b62772e373
2 changed files with 3 additions and 3 deletions
  1. 0 2
      src/lib/config/ccsession.cc
  2. 3 1
      src/lib/config/ccsession.h

+ 0 - 2
src/lib/config/ccsession.cc

@@ -135,8 +135,6 @@ createCommand(const std::string& command, ConstElementPtr arg) {
     return (cmd);
     return (cmd);
 }
 }
 
 
-/// Returns "" and empty ElementPtr() if this does not
-/// look like a command
 std::string
 std::string
 parseCommand(ConstElementPtr& arg, ConstElementPtr command) {
 parseCommand(ConstElementPtr& arg, ConstElementPtr command) {
     if (command &&
     if (command &&

+ 3 - 1
src/lib/config/ccsession.h

@@ -91,11 +91,13 @@ isc::data::ConstElementPtr createCommand(const std::string& command,
 /// \brief Parses the given command into a string containing the actual
 /// \brief Parses the given command into a string containing the actual
 ///        command and an ElementPtr containing the optional argument.
 ///        command and an ElementPtr containing the optional argument.
 ///
 ///
+/// Raises a CCSessionError if this is not a well-formed command
+///
 /// \param arg This value will be set to the ElementPtr pointing to
 /// \param arg This value will be set to the ElementPtr pointing to
 ///        the argument, or to an empty Map (ElementPtr) if there was none.
 ///        the argument, or to an empty Map (ElementPtr) if there was none.
 /// \param command The command message containing the command (as made
 /// \param command The command message containing the command (as made
 ///        by createCommand()
 ///        by createCommand()
-/// \return The command string
+/// \return The command name
 std::string parseCommand(isc::data::ConstElementPtr& arg,
 std::string parseCommand(isc::data::ConstElementPtr& arg,
                          isc::data::ConstElementPtr command);
                          isc::data::ConstElementPtr command);