From 7de3d1c65f2fb63d6b270cc556ae89fb31691386 Mon Sep 17 00:00:00 2001 From: Andre Noll Date: Mon, 10 Nov 2008 22:29:17 +0100 Subject: [PATCH] Add source code documentation for run_select_query() and com_select(). --- select.c | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/select.c b/select.c index 209bf14..5fd763c 100644 --- 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; -- 2.39.2