From 85aba549034af182771694090799f6dbd804cc56 Mon Sep 17 00:00:00 2001 From: Matthew Barnes Date: Wed, 6 Mar 2013 10:01:16 -0500 Subject: Document the enum types in e-util-enums.h. --- e-util/e-util-enums.h | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) (limited to 'e-util/e-util-enums.h') diff --git a/e-util/e-util-enums.h b/e-util/e-util-enums.h index b2da504fb2..71cacc6ecb 100644 --- a/e-util/e-util-enums.h +++ b/e-util/e-util-enums.h @@ -27,6 +27,19 @@ G_BEGIN_DECLS +/** + * EActivityState: + * @E_ACTIVITY_RUNNING: + * The #EActivity is running. + * @E_ACTIVITY_WAITING: + * The #EActivity is waiting to be run. + * @E_ACTIVITY_CANCELLED: + * The #EActivity has been cancelled. + * @E_ACTIVITY_COMPLETED: + * The #EActivity has completed. + * + * Various states of an #EActivity. + **/ typedef enum { E_ACTIVITY_RUNNING, E_ACTIVITY_WAITING, @@ -34,6 +47,20 @@ typedef enum { E_ACTIVITY_COMPLETED } EActivityState; +/** + * EDurationType: + * @E_DURATION_MINUTES: + * Duration value is in minutes. + * @E_DURATION_HOURS: + * Duration value is in hours. + * @E_DURATION_DAYS: + * Duration value is in days. + * + * Possible units for a duration or interval value. + * + * This enumeration is typically used where the numeric value and the + * units of the value are shown or recorded separately. + **/ typedef enum { E_DURATION_MINUTES, E_DURATION_HOURS, -- cgit v1.2.3