From afda2af67fbb467431a61b93b91d9b3de629a4fa Mon Sep 17 00:00:00 2001 From: Guilherme Maciel Ferreira Date: Tue, 31 Jan 2012 23:42:14 -0200 Subject: [PATCH] Small documentation fixes. --- src/config/configurationcommandline.cpp | 9 +++++---- src/config/configurationreader.cpp | 6 +++--- 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/src/config/configurationcommandline.cpp b/src/config/configurationcommandline.cpp index a6cefc0..a00e97e 100644 --- a/src/config/configurationcommandline.cpp +++ b/src/config/configurationcommandline.cpp @@ -130,12 +130,13 @@ bool ConfigurationCommandLine::process( variables_map *vm ) } /** - * @brief Store the parsed tokens in @a configuration + * @brief Store the parsed tokens in @a configuration. * - * @param - * @param + * @param vm The variables_map object where the configuration tokens are stored. + * @param configuration A @c Configuration object to where to save the + * configuration. * - * @return + * @return @c true if parsed successfully, or @c false otherwise. */ bool ConfigurationCommandLine::parse( const variables_map &vm, diff --git a/src/config/configurationreader.cpp b/src/config/configurationreader.cpp index 324d58f..14cb985 100644 --- a/src/config/configurationreader.cpp +++ b/src/config/configurationreader.cpp @@ -57,8 +57,8 @@ ConfigurationReader::~ConfigurationReader() /** * @brief Parses the command line and configuration file. * - * @param argc the number of arguments in command line. - * @param argv a vector containing the command line elements. + * @param argc The number of arguments in command line. + * @param argv A vector containing the command line elements. * * @return @c true if the parsing was successful, otherwise returns @c false. */ @@ -96,7 +96,7 @@ bool ConfigurationReader::parse( } /** - * @return the object containing the configuration data parsed by this object. + * @return The object containing the configuration data parsed by this object. */ Configuration ConfigurationReader::get_configuration() const { -- 1.7.1