Skip to content
Snippets Groups Projects
Commit f0353f93 authored by tho's avatar tho
Browse files

some minor documentation updates

parent d5068cf5
No related branches found
No related tags found
No related merge requests found
......@@ -34,6 +34,7 @@
///////////////////////////////////////////////////////////////////////////
// senf::console::detail::ConfigFileSource
#ifndef DOXYGEN
prefix_ void senf::console::detail::ConfigFileSource::v_parse(RestrictedExecutor & executor)
{
......@@ -47,6 +48,7 @@ prefix_ void senf::console::detail::ConfigFileSource::v_parse(RestrictedExecutor
throw;
}
}
#endif
///////////////////////////////////////////////////////////////////////////
......
......@@ -32,6 +32,7 @@
///////////////////////////////////////////////////////////////////////////
// senf::console::detail::ConfigFileSource
#ifndef DOXYGEN
prefix_ senf::console::detail::ConfigFileSource::ptr
senf::console::detail::ConfigFileSource::create(std::string const & filename)
......@@ -49,6 +50,7 @@ senf::console::detail::ConfigFileSource::ignoreMissing()
prefix_ senf::console::detail::ConfigFileSource::ConfigFileSource(std::string const & filename)
: filename_ (filename), ignoreMissing_ (true)
{}
#endif
///////////////////////////////////////////////////////////////////////////
// senf::console::ConfigFile
......
......@@ -201,6 +201,7 @@ prefix_ std::string senf::console::DirectoryNode::v_shorthelp()
///////////////////////////////////////////////////////////////////////////
// senf::console::detail::NodeTraverser
#ifndef DOXYGEN
prefix_ void senf::console::detail::NodeTraverser::operator()(std::string const & name)
{
......@@ -245,6 +246,7 @@ prefix_ senf::console::GenericNode & senf::console::detail::NodeTraverser::node(
else
return * dir_;
}
#endif
///////////////////////////////////////////////////////////////////////////
// senf::console::SimpleCommandNode
......
......@@ -273,12 +273,14 @@ prefix_ senf::console::DirectoryNode::cptr senf::console::DirectoryNode::thisptr
///////////////////////////////////////////////////////////////////////////
// senf::console::detail::NodeTraverser
#ifndef DOXYGEN
prefix_ senf::console::detail::NodeTraverser::NodeTraverser(DirectoryNode & root,
DirectoryNode & dir,
bool autocomplete)
: root_ (root), dir_ (dir.thisptr()), autocomplete_ (autocomplete), init_ (false)
{}
#endif
///////////////////////////////////////////////////////////////////////////
// senf::console::CommandNode
......
......@@ -632,7 +632,7 @@ namespace console {
///< Execute the command
/**< \param[in] output stream where result messages may be
written to
\param[in] arguments command arguments. This is a
\param[in] command command arguments. This is a
range of ranges of Token instances. */
void execute(boost::any & rv, std::ostream & output, ParseCommandInfo const & command)
......@@ -641,7 +641,7 @@ namespace console {
/**< \param[out] rv command return value
\param[in] output stream where result messages may be
written to
\param[in] arguments command arguments. This is a
\param[in] command command arguments. This is a
range of ranges of Token instances. */
void operator()(std::ostream & output, ParseCommandInfo const & command) const;
......@@ -649,7 +649,7 @@ namespace console {
/**< Same as execute()
\param[in] output stream where result messages may be
written to
\param[in] arguments command arguments. This is a
\param[in] command command arguments. This is a
range of ranges of Token instances. */
void operator()(boost::any & rv, std::ostream & output, ParseCommandInfo const & command)
const;
......@@ -667,7 +667,9 @@ namespace console {
const = 0;
///< Called to execute the command
/**< \param[out] rv return value holder
\param[in] arguments command arguments. This is a
\param[in] os stream where result messages may be
written to
\param[in] command command arguments. This is a
range of ranges of Token instances. */
private:
......
......@@ -90,7 +90,7 @@ namespace console {
empty before this call.
\pre \a index < numArguments()
\param[in] index Argument index
\param[outp doc Argument documentation */
\param[out] doc Argument documentation */
std::string doc() const; ///< Get overload documentation
......
......@@ -225,9 +225,9 @@ namespace term {
LineEditor(AbstractTerminal & terminal, AcceptCallback cb);
///< Create a LineEditor
/**< \parm[in] terminal abstract terminal interface
\parm[in] cb callback to call for complete input
line */
/**< \param[in] terminal abstract terminal interface
\param[in] cb callback to call for complete input
line */
///////////////////////////////////////////////////////////////////////////
......
......@@ -32,6 +32,7 @@
//#include "hexdump.mpp"
#define prefix_
///////////////////////////////cc.p////////////////////////////////////////
#ifndef DOXYGEN
prefix_ void senf::detail::HexDumper::operator()(unsigned char ch)
{
......@@ -65,6 +66,7 @@ prefix_ senf::detail::HexDumper::~HexDumper()
}
}
#endif
///////////////////////////////cc.e////////////////////////////////////////
#undef prefix_
//#include "hexdump.mpp"
......
......@@ -32,12 +32,13 @@
///////////////////////////////////////////////////////////////////////////
//senf::detail::HexDumper
#ifndef DOXYGEN
prefix_ senf::detail::HexDumper::HexDumper(std::ostream & os, unsigned block_size)
: os_ (os), ias_ (os_), block_size_ (block_size), offset_ (0)
{}
#endif
///////////////////////////////cci.e///////////////////////////////////////
#undef prefix_
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment