You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@httpd.apache.org by rb...@locus.apache.org on 2000/08/06 17:34:03 UTC

cvs commit: apache-2.0/src/include util_date.h

rbb         00/08/06 08:34:03

  Modified:    src/include util_date.h
  Log:
  Document util_date.h using ScanDoc
  
  Revision  Changes    Path
  1.14      +33 -0     apache-2.0/src/include/util_date.h
  
  Index: util_date.h
  ===================================================================
  RCS file: /home/cvs/apache-2.0/src/include/util_date.h,v
  retrieving revision 1.13
  retrieving revision 1.14
  diff -u -r1.13 -r1.14
  --- util_date.h	2000/08/02 05:25:29	1.13
  +++ util_date.h	2000/08/06 15:34:03	1.14
  @@ -63,6 +63,10 @@
   extern "C" {
   #endif
   
  +/**
  + * @package Apache date routines
  + */
  +
   /*
    * util_date.h: prototypes for date parsing utility routines
    */
  @@ -71,7 +75,36 @@
   
   #define BAD_DATE (apr_time_t)0
   
  +/**
  + * Compare a string to a mask
  + * @param data The string to compare
  + * @mask Mask characters (arbitrary maximum is 256 characters, just in case):
  + * <PRE>
  + *   @ - uppercase letter
  + *   $ - lowercase letter
  + *   & - hex digit
  + *   # - digit
  + *   ~ - digit or space
  + *   * - swallow remaining characters
  + *  <x> - exact match for any other character
  + * </PRE>
  + * @return 1 if the string matches, 0 otherwise
  + * @deffunc int ap_checkmask(const char *data, const char *mask)
  + */
   API_EXPORT(int) ap_checkmask(const char *data, const char *mask);
  +
  +/**
  + * Parses an HTTP date in one of three standard forms:
  + * <PRE>
  + *     Sun, 06 Nov 1994 08:49:37 GMT  ; RFC 822, updated by RFC 1123
  + *     Sunday, 06-Nov-94 08:49:37 GMT ; RFC 850, obsoleted by RFC 1036
  + *     Sun Nov  6 08:49:37 1994       ; ANSI C's asctime() format
  + * </PRE>
  + * @param date The date in one of the three formats above
  + * @return the apr_time_t number of microseconds since 1 Jan 1970 GMT, or
  + *         0 if this would be out of range or if the date is invalid.
  + * @deffunc apr_time_t ap_parseHTTPdate(const char *date)
  + */
   API_EXPORT(apr_time_t) ap_parseHTTPdate(const char *date);
   
   #ifdef __cplusplus