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/07/29 20:29:12 UTC

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

rbb         00/07/29 11:29:12

  Modified:    src/include ap_mmn.h
  Log:
  Document ap_mmn.h using ScanDoc
  
  Revision  Changes    Path
  1.5       +22 -12    apache-2.0/src/include/ap_mmn.h
  
  Index: ap_mmn.h
  ===================================================================
  RCS file: /home/cvs/apache-2.0/src/include/ap_mmn.h,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- ap_mmn.h	2000/03/31 07:18:53	1.4
  +++ ap_mmn.h	2000/07/29 18:29:12	1.5
  @@ -55,6 +55,10 @@
   #ifndef APACHE_AP_MMN_H
   #define APACHE_AP_MMN_H
   
  +/**
  + * @package Module Magic Number
  + */
  +
   /*
    * MODULE_MAGIC_NUMBER_MAJOR
    * Major API changes that could cause compatibility problems for older modules
  @@ -233,21 +237,27 @@
   #define MODULE_MAGIC_NUMBER_MINOR 1                     /* 0...n */
   #define MODULE_MAGIC_NUMBER MODULE_MAGIC_NUMBER_MAJOR	/* backward compat */
   
  -/* Useful for testing for features. */
  +/**
  + * Determine if the server's current MODULE_MAGIC_NUMBER is at least a
  + * specified value.
  + * <PRE>
  + * Useful for testing for features.
  + * For example, suppose you wish to use the ap_overlap_tables
  + *    function.  You can do this:
  + * 
  + * #if MODULE_MAGIC_AT_LEAST(19980812,2)
  + *     ... use ap_overlap_tables()
  + * #else
  + *     ... alternative code which doesn't use ap_overlap_tables()
  + * #endif
  + * </PRE>
  + * @param major The major module magic number
  + * @param minor The minor module magic number
  + * @deffunc MODULE_MAGIC_AT_LEAST(int major, int minor)
  + */
   #define MODULE_MAGIC_AT_LEAST(major,minor)		\
       ((major) > MODULE_MAGIC_NUMBER_MAJOR 		\
   	|| ((major) == MODULE_MAGIC_NUMBER_MAJOR 	\
   	    && (minor) >= MODULE_MAGIC_NUMBER_MINOR))
  -
  -/* For example, suppose you wish to use the ap_overlap_tables
  -   function.  You can do this:
  -
  -#if MODULE_MAGIC_AT_LEAST(19980812,2)
  -    ... use ap_overlap_tables()
  -#else
  -    ... alternative code which doesn't use ap_overlap_tables()
  -#endif
  -
  -*/
   
   #endif /* !APACHE_AP_MMN_H */