diff options
author | Michael McClurg <michael.mcclurg@outlook.com> | 2020-07-01 10:45:16 -0600 |
---|---|---|
committer | Michael McClurg <michael.mcclurg@outlook.com> | 2020-07-02 10:59:19 -0600 |
commit | afffcdcba075f8c701c4f94e6a639f11b8a65c40 (patch) | |
tree | 9f1c1cb7bb02d4be0efa05494c60112333121342 /src/libicalss | |
parent | 759689f42d1d9a4174721a0d1c55380ac06334bd (diff) | |
download | libical-git-afffcdcba075f8c701c4f94e6a639f11b8a65c40.tar.gz |
Fix missing or unintentional docs
Diffstat (limited to 'src/libicalss')
-rw-r--r-- | src/libicalss/icalclassify.c | 2 | ||||
-rw-r--r-- | src/libicalss/icaldirset.c | 25 | ||||
-rw-r--r-- | src/libicalss/icaldirset.h | 26 |
3 files changed, 27 insertions, 26 deletions
diff --git a/src/libicalss/icalclassify.c b/src/libicalss/icalclassify.c index 2685b087..55f28a11 100644 --- a/src/libicalss/icalclassify.c +++ b/src/libicalss/icalclassify.c @@ -57,7 +57,7 @@ char *icalclassify_lowercase(const char *str) return xnew; } -/* Returns a set of components that intersect in time with comp. For +/** Returns a set of components that intersect in time with comp. For component X and Y to intersect: X.DTSTART < Y.DTEND && X.DTEND > Y.DTSTART */ diff --git a/src/libicalss/icaldirset.c b/src/libicalss/icaldirset.c index dcadc0e1..8f357513 100644 --- a/src/libicalss/icaldirset.c +++ b/src/libicalss/icaldirset.c @@ -20,31 +20,6 @@ Code is Eric Busboom ======================================================================*/ -/** - @file icaldirset.c - - @brief icaldirset manages a database of ical components and offers - interfaces for reading, writing and searching for components. - - icaldirset groups components in to clusters based on their DTSTAMP - time -- all components that start in the same month are grouped - together in a single file. All files in a sotre are kept in a single - directory. - - The primary interfaces are icaldirset__get_first_component and - icaldirset_get_next_component. These routine iterate through all of - the components in the store, subject to the current gauge. A gauge - is an icalcomponent that is tested against other componets for a - match. If a gauge has been set with icaldirset_select, - icaldirset_first and icaldirset_next will only return componentes - that match the gauge. - - The Store generated UIDs for all objects that are stored if they do - not already have a UID. The UID is the name of the cluster (month & - year as MMYYYY) plus a unique serial number. The serial number is - stored as a property of the cluster. - -*/ #ifdef HAVE_CONFIG_H #include <config.h> diff --git a/src/libicalss/icaldirset.h b/src/libicalss/icaldirset.h index 214c3000..2d0e11c7 100644 --- a/src/libicalss/icaldirset.h +++ b/src/libicalss/icaldirset.h @@ -19,6 +19,32 @@ Code is Eric Busboom ======================================================================*/ +/** + @file icaldirset.h + + @brief icaldirset manages a database of ical components and offers + interfaces for reading, writing and searching for components. + + icaldirset groups components in to clusters based on their DTSTAMP + time -- all components that start in the same month are grouped + together in a single file. All files in a sotre are kept in a single + directory. + + The primary interfaces are icaldirset__get_first_component and + icaldirset_get_next_component. These routine iterate through all of + the components in the store, subject to the current gauge. A gauge + is an icalcomponent that is tested against other componets for a + match. If a gauge has been set with icaldirset_select, + icaldirset_first and icaldirset_next will only return componentes + that match the gauge. + + The Store generated UIDs for all objects that are stored if they do + not already have a UID. The UID is the name of the cluster (month & + year as MMYYYY) plus a unique serial number. The serial number is + stored as a property of the cluster. + +*/ + #ifndef ICALDIRSET_H #define ICALDIRSET_H |