Add the latex and html directories to .gitignore.

[adu.git] / adu.h

diff --git a/adu.h b/adu.h
index 8e629692a5c60652994f61f8e33c57bbb15b886a..b9e6ee9f67812764c8b65b7baf41bc9d31ef5978 100644 (file)
--- a/adu.h
+++ b/adu.h
@@ -146,6 +146,7 @@ enum user_table_columns {
        NUM_UT_COLUMNS
 };
 
+/** Flags for the user hash table. */
 enum uid_info_flags {
        /** Whether this slot of the hash table is used. */
        UI_FL_SLOT_USED = 1,
@@ -153,19 +154,36 @@ enum uid_info_flags {
        UI_FL_ADMISSIBLE = 2,
 };
 
+/** Information about one admissible user. */
 struct user_info {
+       /** User ID. */
        uint32_t uid;
+       /** \sa enum uid_info_flags. */
        uint32_t flags;
+       /** The user name.  */
        char *pw_name;
+       /** The user table of this user.*/
        struct osl_table *table;
+       /** Total number of files owned by this user. */
        uint64_t files;
+       /** Total number of bytes owned by this user. */
        uint64_t bytes;
+       /** Total number of directories that contain at least one file */
        uint64_t dirs;
+       /** The description of the user table. */
        struct osl_table_description *desc;
 };
 
+/**
+ * Describes one range of admissible user IDs.
+ *
+ * adu converts the admissible user ids given at the command line
+ * into an array of such structs.
+ */
 struct uid_range {
+       /** Lowest admissible user ID. */
        uint32_t low;
+       /** Greatest admissible user ID. */
        uint32_t high;
 };
 
@@ -178,7 +196,16 @@ enum search_uid_flags {
 
 extern uint32_t num_uids;
 extern struct osl_table *dir_table;
+
+/** The adu command line options. */
 extern struct gengetopt_args_info conf;
+
+/**
+ * The select command line options.
+ *
+ * Either given at the command line, or via the \a set command
+ * in interactive mode.
+ */
 extern struct select_args_info select_conf;
 
 /* adu.c */
@@ -194,12 +221,9 @@ int for_each_admissible_user(int (*func)(struct user_info *, void *),
                void *data);
 void sort_hash_table(int (*comp)(const void *, const void *));
 
-/* select.c */
-int parse_select_options(char *string, struct select_cmdline_parser_params *params,
-               struct uid_range **admissible_uids);
-int run_select_query(struct uid_range *admissible_uids);
-int com_select(void);
-
-/* create.h */
+/* create.c */
 int com_create(void);
+
+/* interactive.c */
+void print_interactive_help(void);
 int com_interactive(void);