libraries/mrw-cxx
1
0
Fork 0
Code Issues Releases Activity

errors in documentation

Browse Source
This commit is contained in:
Marc Wäckerlin
2004-10-07 09:27:01 +00:00
parent 40beb53a91
commit 320498e3b9
1 changed files with 13 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
mrw/exec.hpp
View File

@@ -9,6 +9,9 @@
@license LGPL, see file <a href="license.html">COPYING</a> @license LGPL, see file <a href="license.html">COPYING</a>
$Log$ $Log$
Revision 1.4 2004/10/07 09:27:01 marc
errors in documentation
Revision 1.3 2004/08/28 16:21:25 marc Revision 1.3 2004/08/28 16:21:25 marc
mrw-c++-0.92 (mrw) mrw-c++-0.92 (mrw)
- new file: version.cpp - new file: version.cpp
@@ -131,7 +134,7 @@ namespace mrw {
/** @brief Execute the command. /** @brief Execute the command.
@param bool @param exc
- @c true throw an exception if return status is not zero - @c true throw an exception if return status is not zero
- @c false throw only an exception in case of a fatal error - @c false throw only an exception in case of a fatal error
@@ -141,7 +144,7 @@ namespace mrw {
- if given parameter is @c true (the default) also if the - if given parameter is @c true (the default) also if the
executed program terminates with an error executed program terminates with an error
*/ */
Exec& execute(bool=true) throw(std::exception); Exec& execute(bool exc=true) throw(std::exception);
/** @brief Executes the command if not done, streams @c stdout into a string /** @brief Executes the command if not done, streams @c stdout into a string
@@ -238,19 +241,19 @@ namespace mrw {
class Cmd { class Cmd {
public: public:
/** @brief Create a command given the name of the executable /** @brief Create a command given the name of the executable
@param std::string the name of the program to execute (no parameter) @param command the name of the program to execute (no parameter)
@note There is no default constructor. */ @note There is no default constructor. */
Cmd(const std::string&) throw(std::bad_exception); Cmd(const std::string& command) throw(std::bad_exception);
/** @brief Append a parameter to a command /** @brief Append a parameter to a command
@param std::string a parameter&nbsp;/ commandline argument @param param a parameter&nbsp;/ commandline argument
to append to the command */ to append to the command */
Cmd& operator,(const std::string&) throw(std::bad_exception); Cmd& operator,(const std::string& param) throw(std::bad_exception);
/** @brief Append a parameter to a command /** @brief Append a parameter to a command
@param std::string a parameter&nbsp;/ commandline argument @param param a parameter&nbsp;/ commandline argument
to append to the command */ to append to the command */
Cmd& operator<<(const std::string&) throw(std::bad_exception); Cmd& operator<<(const std::string& param) throw(std::bad_exception);
/** @return the command including parameter */ /** @return the command including parameter */
operator std::string() const throw(std::bad_exception); operator std::string() const throw(std::bad_exception);
@@ -267,7 +270,7 @@ namespace mrw {
mrw::Exec::result() and mrw::Exec::error() provide the mrw::Exec::result() and mrw::Exec::error() provide the
necessary information. necessary information.
@param bool @param exc
- @c true throw an exception if return status is not zero - @c true throw an exception if return status is not zero
- @c false throw only an exception in case of a fatal error - @c false throw only an exception in case of a fatal error
@@ -279,7 +282,7 @@ namespace mrw {
- if given parameter is @c true (the default) also if the - if given parameter is @c true (the default) also if the
executed program terminates with an error executed program terminates with an error
*/ */
Exec execute(bool=true) const throw(std::exception); Exec execute(bool exc=true) const throw(std::exception);
private: private:
/// Exec is allowed to call @c path() and @c args(). /// Exec is allowed to call @c path() and @c args().