Add source code documentation for run_select_query() and com_select().
authorAndre Noll <maan@systemlinux.org>
Mon, 10 Nov 2008 21:29:17 +0000 (22:29 +0100)
committerAndre Noll <maan@systemlinux.org>
Mon, 10 Nov 2008 21:29:17 +0000 (22:29 +0100)
select.c

index 209bf14..5fd763c 100644 (file)
--- a/select.c
+++ b/select.c
@@ -854,6 +854,21 @@ open_file:
        return 1;
 }
 
+/**
+ * Execute a select query.
+ *
+ * \param admissible_uids User IDs to take into account.
+ * \param fi Format information.
+ *
+ * Called once in select mode or for each \a run command in interactive mode.
+ *
+ * Open the output stream and the dir table if not already open. For each
+ * admissible uid, the user table is opened if necessary. After these
+ * preparations, the output according to \a select_mode and \a fi is written to
+ * the output stream.
+ *
+ * \return Standard.
+ */
 int run_select_query(struct uid_range *admissible_uids, struct format_info *fi)
 {
        int ret = open_output_stream();
@@ -963,6 +978,11 @@ help:
        return 0;
 }
 
+/**
+ * Main function for select mode.
+ *
+ * \return Standard.
+ */
 int com_select(void)
 {
        struct uid_range *admissible_uids = NULL;