summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat
-rw-r--r--ChangeLog6
-rw-r--r--TODO6
-rw-r--r--dchroot-dsa/dchroot-dsa-options.h8
-rw-r--r--dchroot-dsa/dchroot-dsa-session.cc21
-rw-r--r--dchroot/dchroot-main-base.h2
-rw-r--r--dchroot/dchroot-main.cc2
-rw-r--r--dchroot/dchroot-options.h7
-rw-r--r--dchroot/dchroot-session-base.cc13
-rw-r--r--dchroot/dchroot-session.cc17
-rw-r--r--sbuild/sbuild-parse-error.h12
-rw-r--r--schroot/schroot-base-main.h4
-rw-r--r--schroot/schroot-base-options.h7
-rw-r--r--schroot/schroot-listmounts-main.h13
-rw-r--r--schroot/schroot-listmounts-options.h7
-rw-r--r--schroot/schroot-main-base.h2
-rw-r--r--schroot/schroot-options-base.h7
-rw-r--r--schroot/schroot-options.h7
-rw-r--r--schroot/schroot-releaselock-main.h2
-rw-r--r--schroot/schroot-releaselock-options.h7
19 files changed, 58 insertions, 92 deletions
diff --git a/ChangeLog b/ChangeLog
index 55c8e262..51c7e956 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,11 @@
2006-07-14 Roger Leigh <rleigh@debian.org>
+ * TODO: Remove completed item.
+
+ * Update doxygen API reference.
+
+2006-07-14 Roger Leigh <rleigh@debian.org>
+
* schroot/schroot-base-main.cc
(run): Return rather than calling exit.
diff --git a/TODO b/TODO
index b8859a50..fda7f611 100644
--- a/TODO
+++ b/TODO
@@ -21,12 +21,6 @@ PLANNED
child process (because the open/close happen in different
processes).
-* Docstring argument namespace usage.
-
- Doxygen is currently failing to parse correct C++ due to what looks
- like namespace bugs in doxygen. It would be great if we could fix
- the code by fully qualifying the namespace where appropriate.
-
* Add API to run multiple commands to replace auth::run().
diff --git a/dchroot-dsa/dchroot-dsa-options.h b/dchroot-dsa/dchroot-dsa-options.h
index 6fdad62a..63c1f57a 100644
--- a/dchroot-dsa/dchroot-dsa-options.h
+++ b/dchroot-dsa/dchroot-dsa-options.h
@@ -31,13 +31,7 @@ namespace dchroot_dsa
class options : public schroot::options_base
{
public:
-
- /**
- * The constructor.
- *
- * @param argc the number of arguments.
- * @param argv the list of arguments.
- */
+ /// The constructor.
options ();
/// The destructor.
diff --git a/dchroot-dsa/dchroot-dsa-session.cc b/dchroot-dsa/dchroot-dsa-session.cc
index 045bbe65..53814049 100644
--- a/dchroot-dsa/dchroot-dsa-session.cc
+++ b/dchroot-dsa/dchroot-dsa-session.cc
@@ -39,14 +39,13 @@
using std::cout;
using std::endl;
using boost::format;
-using sbuild::string_list;
using namespace dchroot_dsa;
-session::session (std::string const& service,
- config_ptr& config,
- operation operation,
- string_list const& chroots,
- bool compat):
+session::session (std::string const& service,
+ config_ptr& config,
+ operation operation,
+ sbuild::string_list const& chroots,
+ bool compat):
dchroot::session_base(service, config, operation, chroots, compat)
{
}
@@ -66,8 +65,8 @@ session::get_chroot_auth_status (sbuild::auth::status status,
if (get_compat() == true)
{
- string_list const& users = chroot->get_users();
- string_list const& groups = chroot->get_groups();
+ sbuild::string_list const& users = chroot->get_users();
+ sbuild::string_list const& groups = chroot->get_groups();
if (this->get_ruid() == this->get_uid() &&
users.empty() && groups.empty())
@@ -87,10 +86,10 @@ session::get_chroot_auth_status (sbuild::auth::status status,
return status;
}
-string_list
+sbuild::string_list
session::get_login_directories () const
{
- string_list ret;
+ sbuild::string_list ret;
ret.push_back(get_home());
@@ -104,7 +103,7 @@ session::get_login_directories () const
void
session::get_user_command (sbuild::chroot::ptr& session_chroot,
std::string& file,
- string_list& command) const
+ sbuild::string_list& command) const
{
std::string programstring = command[0];
file = programstring;
diff --git a/dchroot/dchroot-main-base.h b/dchroot/dchroot-main-base.h
index e150eec0..504d8d56 100644
--- a/dchroot/dchroot-main-base.h
+++ b/dchroot/dchroot-main-base.h
@@ -35,6 +35,8 @@ namespace dchroot
/**
* The constructor.
*
+ * @param program_name the program name.
+ * @param program_usage the program usage message.
* @param options the command-line options to use.
*/
main_base (std::string const& program_name,
diff --git a/dchroot/dchroot-main.cc b/dchroot/dchroot-main.cc
index e9fcd899..6129c268 100644
--- a/dchroot/dchroot-main.cc
+++ b/dchroot/dchroot-main.cc
@@ -39,7 +39,7 @@ using boost::format;
using schroot::options_base;
using namespace dchroot;
-main::main (options_base::ptr& options):
+main::main (schroot::options_base::ptr& options):
main_base("dchroot",
_("[OPTION...] [COMMAND] - run command or shell in a chroot"),
options)
diff --git a/dchroot/dchroot-options.h b/dchroot/dchroot-options.h
index 18ebd8f0..7e0ee343 100644
--- a/dchroot/dchroot-options.h
+++ b/dchroot/dchroot-options.h
@@ -31,12 +31,7 @@ namespace dchroot
class options : public schroot::options_base
{
public:
- /**
- * The constructor.
- *
- * @param argc the number of arguments.
- * @param argv the list of arguments.
- */
+ /// The constructor.
options ();
/// The destructor.
diff --git a/dchroot/dchroot-session-base.cc b/dchroot/dchroot-session-base.cc
index 01fca798..0b161d81 100644
--- a/dchroot/dchroot-session-base.cc
+++ b/dchroot/dchroot-session-base.cc
@@ -39,14 +39,13 @@
using std::cout;
using std::endl;
using boost::format;
-using sbuild::string_list;
using namespace dchroot;
-session_base::session_base (std::string const& service,
- config_ptr& config,
- operation operation,
- string_list const& chroots,
- bool compat):
+session_base::session_base (std::string const& service,
+ config_ptr& config,
+ operation operation,
+ sbuild::string_list const& chroots,
+ bool compat):
sbuild::session(service, config, operation, chroots),
compat(compat)
{
@@ -81,7 +80,7 @@ session_base::run_impl ()
sbuild::session::run_impl();
}
-string_list
+sbuild::string_list
session_base::get_command_directories () const
{
// dchroot does not treat logins differently from commands with
diff --git a/dchroot/dchroot-session.cc b/dchroot/dchroot-session.cc
index 5991d5b9..3eb42a92 100644
--- a/dchroot/dchroot-session.cc
+++ b/dchroot/dchroot-session.cc
@@ -39,14 +39,13 @@
using std::cout;
using std::endl;
using boost::format;
-using sbuild::string_list;
using namespace dchroot;
-session::session (std::string const& service,
- config_ptr& config,
- operation operation,
- string_list const& chroots,
- bool compat):
+session::session (std::string const& service,
+ config_ptr& config,
+ operation operation,
+ sbuild::string_list const& chroots,
+ bool compat):
session_base(service, config, operation, chroots, compat)
{
}
@@ -69,10 +68,10 @@ session::get_chroot_auth_status (sbuild::auth::status status,
return status;
}
-string_list
+sbuild::string_list
session::get_login_directories () const
{
- string_list ret;
+ sbuild::string_list ret;
// Set current working directory only if preserving environment.
// Only change to home if not preserving the environment.
@@ -91,7 +90,7 @@ session::get_login_directories () const
void
session::get_user_command (sbuild::chroot::ptr& session_chroot,
std::string& file,
- string_list& command) const
+ sbuild::string_list& command) const
{
std::string programstring = sbuild::string_list_to_string(command, " ");
diff --git a/sbuild/sbuild-parse-error.h b/sbuild/sbuild-parse-error.h
index 8734c163..e2e0def1 100644
--- a/sbuild/sbuild-parse-error.h
+++ b/sbuild/sbuild-parse-error.h
@@ -146,7 +146,7 @@ namespace sbuild
* The constructor.
*
* @param context the context of the error.
- * @param error the error code.
+ * @param error the error.
*/
template<typename A>
parse_error (A const& context,
@@ -159,7 +159,7 @@ namespace sbuild
* The constructor.
*
* @param line the line the error occured on.
- * @param detail the details of the error.
+ * @param error the error.
*/
parse_error (size_t line,
std::runtime_error const& error):
@@ -172,7 +172,7 @@ namespace sbuild
*
* @param line the line the error occured on.
* @param group the group the error occured within.
- * @param error the error code.
+ * @param error the error.
*/
parse_error (size_t line,
std::string const& group,
@@ -187,7 +187,7 @@ namespace sbuild
* @param line the line the error occured on.
* @param group the group the error occured within.
* @param key the key the error occured within.
- * @param error the error code.
+ * @param error the error.
*/
parse_error (size_t line,
std::string const& group,
@@ -201,7 +201,7 @@ namespace sbuild
* The constructor.
*
* @param group the group the error occured within.
- * @param error the error code.
+ * @param error the error.
*/
parse_error (std::string const& group,
std::runtime_error const& error):
@@ -214,7 +214,7 @@ namespace sbuild
*
* @param group the group the error occured within.
* @param key the key the error occured within.
- * @param error the error code.
+ * @param error the error.
*/
parse_error (std::string const& group,
std::string const& key,
diff --git a/schroot/schroot-base-main.h b/schroot/schroot-base-main.h
index 6f635c5d..e6384aa0 100644
--- a/schroot/schroot-base-main.h
+++ b/schroot/schroot-base-main.h
@@ -38,7 +38,9 @@ namespace schroot_base
/**
* The constructor.
*
- * @param program_name the name of the program.
+ * @param program_name the program name.
+ * @param program_usage the program usage message.
+ * @param program_options the command-line options to use.
*/
main (std::string const& program_name,
std::string const& program_usage,
diff --git a/schroot/schroot-base-options.h b/schroot/schroot-base-options.h
index d9336c0a..e8404153 100644
--- a/schroot/schroot-base-options.h
+++ b/schroot/schroot-base-options.h
@@ -51,12 +51,7 @@ namespace schroot_base
/// A shared_ptr to an options object.
typedef std::tr1::shared_ptr<options> ptr;
- /**
- * The constructor.
- *
- * @param argc the number of arguments.
- * @param argv the list of arguments.
- */
+ /// The constructor.
options ();
/// The destructor.
diff --git a/schroot/schroot-listmounts-main.h b/schroot/schroot-listmounts-main.h
index 4c2d6d23..12e35f5d 100644
--- a/schroot/schroot-listmounts-main.h
+++ b/schroot/schroot-listmounts-main.h
@@ -42,23 +42,23 @@ namespace schroot_listmounts
/// The destructor.
virtual ~main ();
+ private:
/**
- * List mounts.
+ * List mounts (internal helper).
*
- * @param mountfile the file containing the database of mounted filesystems.
- * @param mountpoint the mount point to check for.
+ * @param mountfile the file containing the database of mounted
+ * filesystems.
*/
sbuild::string_list
list_mounts (std::string const& mountfile) const;
/**
- * Release lock.
- *
- * @param stream the stream to output to.
+ * List mounts.
*/
virtual void
action_listmounts ();
+ protected:
/**
* Run the program.
*
@@ -68,6 +68,7 @@ namespace schroot_listmounts
virtual int
run_impl ();
+ private:
/// The program options.
options::ptr options;
};
diff --git a/schroot/schroot-listmounts-options.h b/schroot/schroot-listmounts-options.h
index b8943e3f..47bea112 100644
--- a/schroot/schroot-listmounts-options.h
+++ b/schroot/schroot-listmounts-options.h
@@ -44,12 +44,7 @@ namespace schroot_listmounts
ACTION_VERSION ///< Display program version.
};
- /**
- * The constructor.
- *
- * @param argc the number of arguments.
- * @param argv the list of arguments.
- */
+ /// The constructor.
options ();
/// The destructor.
diff --git a/schroot/schroot-main-base.h b/schroot/schroot-main-base.h
index 53f6d1eb..4c0ceb47 100644
--- a/schroot/schroot-main-base.h
+++ b/schroot/schroot-main-base.h
@@ -50,6 +50,8 @@ namespace schroot
/**
* The constructor.
*
+ * @param program_name the program name.
+ * @param program_usage the program usage message.
* @param options the command-line options to use.
*/
main_base (std::string const& program_name,
diff --git a/schroot/schroot-options-base.h b/schroot/schroot-options-base.h
index cc6e370c..bc800bb8 100644
--- a/schroot/schroot-options-base.h
+++ b/schroot/schroot-options-base.h
@@ -69,12 +69,7 @@ namespace schroot
/// A shared_ptr to an options_base object.
typedef std::tr1::shared_ptr<options_base> ptr;
- /**
- * The constructor.
- *
- * @param argc the number of arguments.
- * @param argv the list of arguments.
- */
+ /// The constructor.
options_base ();
/// The destructor.
diff --git a/schroot/schroot-options.h b/schroot/schroot-options.h
index fa577444..54ad9eff 100644
--- a/schroot/schroot-options.h
+++ b/schroot/schroot-options.h
@@ -31,12 +31,7 @@ namespace schroot
class options : public options_base
{
public:
- /**
- * The constructor.
- *
- * @param argc the number of arguments.
- * @param argv the list of arguments.
- */
+ /// The constructor.
options ();
/// The destructor.
diff --git a/schroot/schroot-releaselock-main.h b/schroot/schroot-releaselock-main.h
index fa0d9c1c..d50304d9 100644
--- a/schroot/schroot-releaselock-main.h
+++ b/schroot/schroot-releaselock-main.h
@@ -58,8 +58,6 @@ namespace schroot_releaselock
/**
* Release lock.
- *
- * @param stream the stream to output to.
*/
virtual void
action_releaselock ();
diff --git a/schroot/schroot-releaselock-options.h b/schroot/schroot-releaselock-options.h
index 6abf9a7b..91317d80 100644
--- a/schroot/schroot-releaselock-options.h
+++ b/schroot/schroot-releaselock-options.h
@@ -44,12 +44,7 @@ namespace schroot_releaselock
ACTION_VERSION ///< Display program version.
};
- /**
- * The constructor.
- *
- * @param argc the number of arguments.
- * @param argv the list of arguments.
- */
+ /// The constructor.
options ();
/// The destructor.
generated by cgit v1.2.3 (git 2.39.1) at 2024-06-16 10:26:18 +0000