diff options
author | Matthew Barnes <mbarnes@redhat.com> | 2013-03-06 23:01:16 +0800 |
---|---|---|
committer | Matthew Barnes <mbarnes@redhat.com> | 2013-03-06 23:01:16 +0800 |
commit | 85aba549034af182771694090799f6dbd804cc56 (patch) | |
tree | 2883bb541e952beb2c7d57fa1dd3a59533f02b11 /e-util | |
parent | 2eed198738d3637220fba7d1ce0c49ec6a840928 (diff) | |
download | gsoc2013-evolution-85aba549034af182771694090799f6dbd804cc56.tar.gz gsoc2013-evolution-85aba549034af182771694090799f6dbd804cc56.tar.zst gsoc2013-evolution-85aba549034af182771694090799f6dbd804cc56.zip |
Document the enum types in e-util-enums.h.
Diffstat (limited to 'e-util')
-rw-r--r-- | e-util/e-util-enums.h | 27 |
1 files changed, 27 insertions, 0 deletions
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, |