diff options
| author |   Mu Qiao <qiaomuf@gentoo.org> | 2011-08-04 16:15:22 +0800 |
|---|---|---|
| committer | Mu Qiao <qiaomuf@gentoo.org> | 2011-08-04 22:15:15 +0800 |
| commit | 91ee8a8b27cb9b2523aba0513ec2563c5679cd12 (patch) | |
| tree | e3df194133df63a90c1c7fe83737f5287ac2ef7a /include | |
| parent | Doc: reduce doxygen warnings (diff) | |
| download | libbash-91ee8a8b27cb9b2523aba0513ec2563c5679cd12.tar.gz libbash-91ee8a8b27cb9b2523aba0513ec2563c5679cd12.tar.bz2 libbash-91ee8a8b27cb9b2523aba0513ec2563c5679cd12.zip | |
Doc: generate docs for public headers
Documentation for libbash.h is fixed.
Diffstat (limited to 'include')
| -rw-r--r-- | include/libbash.h | 16 |
1 files changed, 9 insertions, 7 deletions
diff --git a/include/libbash.h b/include/libbash.h index bc065f3..ecac566 100644 --- a/include/libbash.h +++ b/include/libbash.h @@ -32,14 +32,16 @@ #include "common.h" #include "exceptions.h" +/// \namespace libbash +/// \brief public namespace for libbash API namespace libbash { /// /// \brief interpret a script specifid by path, return a map filled with /// variables defined in the script - /// \param the path of target script - /// \param[in, out] we use the map to initialize bash environment and store the result - /// \param[out] store the names of the functions defined in the script + /// \param target_path the path of target script + /// \param[in, out] variables used to initialize bash environment and store the variable values + /// \param[out] functions store the names of the functions defined in the script /// \return the return status of the script int LIBBASH_API interpret(const std::string& target_path, std::unordered_map<std::string, std::vector<std::string>>& variables, @@ -48,10 +50,10 @@ namespace libbash /// /// \brief interpret a script specifid by path, return a map filled with /// variables defined in the script - /// \param the path of target script - /// \param the path of a script that you want to source before interpreting - /// \param[in, out] we use the map to initialize bash environment and store the result. The environment will be initialized after preloading. - /// \param[out] store the names of the functions defined in the script + /// \param target_path the path of target script + /// \param preload_path the path of a script that you want to source before interpreting + /// \param[in, out] variables used to initialize bash environment and store the variable values. The environment will be initialized after preloading. + /// \param[out] functions store the names of the functions defined in the script /// \return the return status of the script int LIBBASH_API interpret(const std::string& target_path, const std::string& preload_path, |