Aren/haiku
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added a \brief for the file.

Browse Source 
Now uses <span class="var"> instead of \p for variables in the text.


git-svn-id: file:///srv/svn/repos/haiku/trunk/current@4389 a95241bf-73f2-0310-859d-f6bbb57e9c96
This commit is contained in:
Axel Dörfler 2003-08-27 03:46:29 +00:00
parent d99a9fa0a5
commit c04f2d92ca
1 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/user/support/parsedate.dox
View File

@ -1,4 +1,6 @@
/** \file parsedate.h /** \file parsedate.h
\brief date parsing functions
This is a set a functions for parsing date strings in various formats. 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's mostly tailored for parsing user given data, although originally,
it was developed to parse the date strings found in usenet messages. 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) /** \fn time_t parsedate(const char *dateString, time_t relativeTo)
\brief Parses \p dateString relative to \p relativeTo \brief Parses <span class="var">dateString</span> relative to <span class="var">relativeTo</span>
Parses the given \p dateString relative to the time specified by \p relativeTo Parses the given <span class="var">dateString</span> relative to the time
using the internal formats table. specified by <span class="var">relativeTo</span> using the internal formats
table.
\param dateString the date that should be parsed, i.e. "next thursday" \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 \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 <span class="var">dateString</span>
could not be parsed.
*/ */
/** \fn time_t parsedate_etc(const char *dateString, time_t relativeTo, int *_storedFlags) /** \fn time_t parsedate_etc(const char *dateString, time_t relativeTo, int *_storedFlags)
\brief Parses \p dateString relative to \p relativeTo \brief Parses <span class="var">dateString</span> relative to <span class="var">relativeTo</span>
This does basically the same as parsedate(), but will set the following This does basically the same as parsedate(), but will set the following
flags in \p _storedFlags: flags in <span class="var">_storedFlags</span>:
\htmlonly \htmlonly
<table border=1> <table border=1>
<!-- ToDo: this certainly is a hack --> <!-- ToDo: this certainly is a hack -->
@ -142,7 +146,7 @@ flags in \p _storedFlags:
\brief sets the internal format table for parsedate() \brief sets the internal format table for parsedate()
This function let you set the format table which is used by 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 <span class="var">formatTable</span> is NULL, the standard built-in format table will be set again.
\param formatTable the NULL terminated formats list. This list must stay \param formatTable the NULL terminated formats list. This list must stay
valid when using parsedate() - it is not copied, but directly used. valid when using parsedate() - it is not copied, but directly used.
\see \see