diff --git a/docs/user/support/parsedate.dox b/docs/user/support/parsedate.dox index 0bcb80f855..404daa69c4 100644 --- a/docs/user/support/parsedate.dox +++ b/docs/user/support/parsedate.dox @@ -1,4 +1,6 @@ /** \file parsedate.h +\brief date parsing functions + This is a set a functions for parsing date strings in various formats. It's mostly tailored for parsing user given data, although originally, it was developed to parse the date strings found in usenet messages. @@ -101,21 +103,23 @@ For example, this may happen if there are some unknown words in that string. */ /** \fn time_t parsedate(const char *dateString, time_t relativeTo) -\brief Parses \p dateString relative to \p relativeTo +\brief Parses dateString relative to relativeTo -Parses the given \p dateString relative to the time specified by \p relativeTo -using the internal formats table. +Parses the given dateString relative to the time +specified by relativeTo using the internal formats +table. \param dateString the date that should be parsed, i.e. "next thursday" \param relativeTo all relative dates will be relative to this time, if -1 is passed, the current time will be used -\return the parsed time value or -1 if the \p dateString could not be parsed. +\return the parsed time value or -1 if the dateString +could not be parsed. */ /** \fn time_t parsedate_etc(const char *dateString, time_t relativeTo, int *_storedFlags) -\brief Parses \p dateString relative to \p relativeTo +\brief Parses dateString relative to relativeTo This does basically the same as parsedate(), but will set the following -flags in \p _storedFlags: +flags in _storedFlags: \htmlonly