cleanup: lxc_container::want_* comment descriptions

They change a value and return true on success rather than fetching the value as the comments previously suggested. Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com> Acked-by: Serge E. Hallyn <serge.hallyn@ubuntu.com>

cleanup: lxc_container::want_* comment descriptions
289cdc73 · Wolfgang Bumiller · Stéphane Graber · 8f43e535 · 289cdc73
Commit 289cdc73 authored Jan 14, 2016 by Wolfgang Bumiller Committed by Stéphane Graber Jan 28, 2016
Hide whitespace changes
Inline Side-by-side

Showing with 4 additions and 5 deletions

lxccontainer.h src/lxc/lxccontainer.h +4 -5

No files found.
--- a/src/lxc/lxccontainer.h
+++ b/src/lxc/lxccontainer.h
@@ -222,25 +222,24 @@ struct lxc_container {
 	bool (*stop)(struct lxc_container *c);
 	/*!
-	 * \brief Determine if the container wants to run disconnected
+	 * \brief Change whether the container wants to run disconnected
 	 * from the terminal.
 	 *
 	 * \param c Container.
 	 * \param state Value for the daemonize bit (0 or 1).
 	 *
-	 * \return \c true if container wants to be daemonised, else \c false.
+	 * \return \c true on success, else \c false.
 	 */
 	bool (*want_daemonize)(struct lxc_container *c, bool state);
 	/*!
-	 * \brief Determine whether container wishes all file descriptors
+	 * \brief Change whether the container wishes all file descriptors
 	 *  to be closed on startup.
 	 *
 	 * \param c Container.
 	 * \param state Value for the close_all_fds bit (0 or 1).
 	 *
-	 * \return \c true if container wants all file descriptors closed,
+	 * \return \c true on success, else \c false.
-	 *  else \c false.
 	 */
 	bool (*want_close_all_fds)(struct lxc_container *c, bool state);