diff options
author | Patrick Elsen <pelsen@xfbs.net> | 2017-07-11 18:15:36 +0200 |
---|---|---|
committer | Patrick Elsen <pelsen@xfbs.net> | 2017-07-12 19:44:16 +0200 |
commit | 6234bf5b97b91c3537429b55d56503b19b411756 (patch) | |
tree | 000472f4956e78677332e782db124e9905619177 | |
parent | 513ff3eb20c36a441eea8794b1f532a588f2cd61 (diff) | |
download | libical-git-6234bf5b97b91c3537429b55d56503b19b411756.tar.gz |
libical/icalparser.h - adds more doxygen documentation
-rw-r--r-- | src/libical/icalparser.h | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/src/libical/icalparser.h b/src/libical/icalparser.h index 589382bc..9dcda423 100644 --- a/src/libical/icalparser.h +++ b/src/libical/icalparser.h @@ -80,8 +80,8 @@ LIBICAL_ICAL_EXPORT icalparser *icalparser_new(void); /** * @brief Adds a single line to be parsed by the icalparser. - * @param parser The current parser - * @param str A single line to be parsed + * @param parser The parser to use + * @param str A string representing a single line of RFC5545-formatted iCalendar data * @return When this was the last line of the component to be parsed, * it returns the icalcomponent, otherwise it returns `NULL`. * @@ -93,6 +93,9 @@ LIBICAL_ICAL_EXPORT icalcomponent *icalparser_add_line(icalparser *parser, char * @brief Cleans out an icalparser and returns parsed component * @param parser The icalparser to clean * @return The parsed component + * + * This will parse components even if it hasn't encountered a proper + * END tag for it yet and return them. */ LIBICAL_ICAL_EXPORT icalcomponent *icalparser_clean(icalparser *parser); |