From c04f2d92cabc9fb07c3a8d2e609cb6e5bd89cd4f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Axel=20D=C3=B6rfler?= Date: Wed, 27 Aug 2003 03:46:29 +0000 Subject: [PATCH] Added a \brief for the file. Now uses instead of \p for variables in the text. git-svn-id: file:///srv/svn/repos/haiku/trunk/current@4389 a95241bf-73f2-0310-859d-f6bbb57e9c96 --- docs/user/support/parsedate.dox | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) 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 @@ -142,7 +146,7 @@ flags in \p _storedFlags: \brief sets the internal format table for parsedate() This function let you set the format table which is used by parsedate(). -When \c formatTable is NULL, the standard built-in format table will be set again. +When formatTable is NULL, the standard built-in format table will be set again. \param formatTable the NULL terminated formats list. This list must stay valid when using parsedate() - it is not copied, but directly used. \see