From c357c47be8a3f210f9eee9a05cc13f1051b036d3 Mon Sep 17 00:00:00 2001 From: Alex Gilday Date: Wed, 21 Mar 2018 13:54:09 +0000 Subject: COMPMID-1008: Fix Doxygen issues Change-Id: Ie73d8771f85d1f5b059f3a56f1bbd73c98e94a38 Reviewed-on: https://eu-gerrit-1.euhpc.arm.com/124723 Reviewed-by: Michalis Spyrou Tested-by: Jenkins --- tests/framework/command_line/SimpleOption.h | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) (limited to 'tests/framework/command_line/SimpleOption.h') diff --git a/tests/framework/command_line/SimpleOption.h b/tests/framework/command_line/SimpleOption.h index e6e8045840..d02778e781 100644 --- a/tests/framework/command_line/SimpleOption.h +++ b/tests/framework/command_line/SimpleOption.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2017 ARM Limited. + * Copyright (c) 2017-2018 ARM Limited. * * SPDX-License-Identifier: MIT * @@ -50,9 +50,25 @@ public: */ SimpleOption(std::string name, T default_value); + /** Parses the given string. + * + * @param[in] value String representation as passed on the command line. + * + * @return True if the value could be parsed by the specific subclass. + */ bool parse(std::string value) override; + + /** Help message for the option. + * + * @return String representing the help message for the specific subclass. + */ std::string help() const override; - const T &value() const; + + /** Get the option value. + * + * @return the option value. + */ + const T &value() const; protected: T _value{}; -- cgit v1.2.1