summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael McClurg <michael.mcclurg@outlook.com>2020-06-30 10:59:36 -0600
committerMichael McClurg <michael.mcclurg@outlook.com>2020-06-30 10:59:36 -0600
commit203efe2b22b133803f2d9c5e0077c2911fc68409 (patch)
tree3a22a451a418d1fc83f26506da7042840fa61078
parent5fe74c71d1d996b813c5737dc99e3063a8b8fbcf (diff)
downloadlibical-git-203efe2b22b133803f2d9c5e0077c2911fc68409.tar.gz
Fix small missing pieces of documentation
-rw-r--r--src/libical/icalcomponent.h2
-rw-r--r--src/libical/icalparser.h1
-rw-r--r--src/libical/icalperiod.h2
3 files changed, 4 insertions, 1 deletions
diff --git a/src/libical/icalcomponent.h b/src/libical/icalcomponent.h
index 66b4526f..73b3c1a6 100644
--- a/src/libical/icalcomponent.h
+++ b/src/libical/icalcomponent.h
@@ -285,7 +285,7 @@ LIBICAL_ICAL_EXPORT void icalcomponent_foreach_recurrence(icalcomponent *comp,
*/
LIBICAL_ICAL_EXPORT void icalcomponent_normalize(icalcomponent *comp);
-/*
+/**
* Computes the datetime corresponding to the specified @p icalproperty and @p icalcomponent.
* If the property is a DATE-TIME with a TZID parameter and a corresponding VTIMEZONE
* is present in the component, the returned component will already be in the correct
diff --git a/src/libical/icalparser.h b/src/libical/icalparser.h
index 1c0571b9..8d684c07 100644
--- a/src/libical/icalparser.h
+++ b/src/libical/icalparser.h
@@ -318,6 +318,7 @@ LIBICAL_ICAL_EXPORT icalcomponent *icalparser_parse_string(const char *str);
/**
* @brief Given a line generator function, returns a single iCal content line.
+ * @return A pointer to a single line of data or `NULL` if it reached
* end of file reading from the @a line_gen_func. Note that the pointer
* returned is owned by libical and must not be `free()`d by the user.
* @param parser The parser object to use
diff --git a/src/libical/icalperiod.h b/src/libical/icalperiod.h
index 5c62ebc6..6f2be741 100644
--- a/src/libical/icalperiod.h
+++ b/src/libical/icalperiod.h
@@ -148,6 +148,7 @@ LIBICAL_ICAL_EXPORT struct icalperiodtype icalperiodtype_null_period(void);
/**
* Checks if a given ::icalperiodtype is a null period.
+ * @param p The time period to check
* @return 1 if @a p is a null period, 0 otherwise
* @sa icalperiodtype_null_period()
*
@@ -164,6 +165,7 @@ LIBICAL_ICAL_EXPORT int icalperiodtype_is_null_period(struct icalperiodtype p);
/**
* Checks if a given ::icalperiodtype is a valid period.
+ * @param p The time period to check
* @return 1 if @a p is a valid period, 0 otherwise
*
* ### Usage