formatting, typos, comments, details

Change-Id: Iae5f1acb653a694622e9ac2bad93efcfca588f3a

src/core/util/CommandLine.hpp

@@ -17,93 +17,94 @@
 #pragma GCC diagnostic pop
 
 namespace fail {
-    /**
-     * @class CommandLine
-     * @brief Implements a command line interface, that filters the
-     * simulators command line. It is a Singleton.
-     */
-    class CommandLine {
-    public:
-        typedef int argument_count;
-        typedef char **argument_value;
-    private:
-        static CommandLine m_instance;
 
-        std::vector<const char *> argv;
-        std::vector<option::Descriptor> options;
-        option::Option *parsed_options, *parsed_buffer;
-        option::Parser *m_parser;
-    public:
-        /// Handle for accessing the parsed data of an option
-        typedef int option_handle;
+/**
+ * @class CommandLine
+ * @brief Implements a command line interface, that filters the
+ * simulators command line. It is a Singleton.
+ */
+class CommandLine {
+public:
+	typedef int argument_count;
+	typedef char **argument_value;
+private:
+	static CommandLine m_instance;
 
-        /**
-         * Singleton accessor
-         *
-         * @return reference to the CommandLine singleton object
-         */
-        static CommandLine &Inst() { return m_instance; }
+	std::vector<const char *> argv;
+	std::vector<option::Descriptor> options;
+	option::Option *parsed_options, *parsed_buffer;
+	option::Parser *m_parser;
+public:
+	/// Handle for accessing the parsed data of an option
+	typedef int option_handle;
 
-        /**
-         * Called by the simulator to filter all fail arguments from
-         * argc, argv
-         */
-        void collect_args(argument_count &, argument_value &);
+	/**
+	 * Singleton accessor
+	 *
+	 * @return reference to the CommandLine singleton object
+	 */
+	static CommandLine &Inst() { return m_instance; }
 
-        /**
-         * Add a argument manually
-         */
-        void add_args(const char *value) { argv.push_back(value); }
+	/**
+	 * Called by the simulator to filter all fail arguments from
+	 * argc, argv
+	 */
+	void collect_args(argument_count &, argument_value &);
 
-        /**
-         * Add a option to the command line interface of the fail-client
-         *
-         * @param shortopt e.g "m" for -m
-         * @param longopt e.g. "memory-region" for --memory-region=
-         * @param check_arg argument is required.
-         * @param help help text to be printed for -h
-         *
-         * @return return handle to option
-         */
-        option_handle addOption(const std::string &shortopt,
-                                const std::string &longopt,
-                                const option::CheckArg & check_arg,
-                                const std::string &help);
+	/**
+	 * Add a argument manually
+	 */
+	void add_args(const char *value) { argv.push_back(value); }
 
-        /**
-         *
-         * do the actual parsing, called by the experiment
-         *
-         * @return true on success
-         */
-        bool parse();
+	/**
+	 * Add a option to the command line interface of the fail-client
+	 *
+	 * @param shortopt e.g "m" for -m
+	 * @param longopt e.g. "memory-region" for --memory-region=
+	 * @param check_arg argument is required.
+	 * @param help help text to be printed for -h
+	 *
+	 * @return return handle to option
+	 */
+	option_handle addOption(const std::string &shortopt,
+		const std::string &longopt,
+		const option::CheckArg & check_arg,
+		const std::string &help);
 
-        /**
-         * Accessor for the command line option objects
-         *
-         * @param handle option handle
-         *
-         * @return reference to the option parser object
-         */
-        option::Option &operator[](option_handle handle) {
-            assert(parsed_options != 0);
-            assert(handle >= 0 && handle < (int)options.size());
-            return parsed_options[handle];
-        }
-        /**
-         * Print help message.
-         */
-        void printUsage() {
-            int columns = getenv("COLUMNS")? atoi(getenv("COLUMNS")) : 80;
-            option::printUsage(fwrite, stdout, options.data(), columns);
-        }
-        /**
-         * Return the internal option::Parser object for further usage.
-         */
-        option::Parser *parser() {
-            return m_parser;
-        }
-    };
+	/**
+	 *
+	 * do the actual parsing, called by the experiment
+	 *
+	 * @return true on success
+	 */
+	bool parse();
+
+	/**
+	 * Accessor for the command line option objects
+	 *
+	 * @param handle option handle
+	 *
+	 * @return reference to the option parser object
+	 */
+	option::Option &operator[](option_handle handle) {
+		assert(parsed_options != 0);
+		assert(handle >= 0 && handle < (int)options.size());
+		return parsed_options[handle];
+	}
+	/**
+	 * Print help message.
+	 */
+	void printUsage() {
+		int columns = getenv("COLUMNS")? atoi(getenv("COLUMNS")) : 80;
+		option::printUsage(fwrite, stdout, options.data(), columns);
+	}
+	/**
+	 * Return the internal option::Parser object for further usage.
+	 */
+	option::Parser *parser() {
+		return m_parser;
+	}
+};
 
 } // end of namespace