You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@httpd.apache.org by ja...@apache.org on 2014/07/19 12:30:42 UTC
svn commit: r1611880 - /httpd/httpd/trunk/include/ap_mmn.h
Author: jailletc36
Date: Sat Jul 19 10:30:42 2014
New Revision: 1611880
URL: http://svn.apache.org/r1611880
Log:
Improve doxygen comment.
Use a comment already present as the doxygen description of the module.
Remove a useless @def.
Modified:
httpd/httpd/trunk/include/ap_mmn.h
Modified: httpd/httpd/trunk/include/ap_mmn.h
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/include/ap_mmn.h?rev=1611880&r1=1611879&r2=1611880&view=diff
==============================================================================
--- httpd/httpd/trunk/include/ap_mmn.h (original)
+++ httpd/httpd/trunk/include/ap_mmn.h Sat Jul 19 10:30:42 2014
@@ -20,25 +20,23 @@
*
* @defgroup APACHE_CORE_MMN Module Magic Number
* @ingroup APACHE_CORE
- * @{
- */
-
-#ifndef APACHE_AP_MMN_H
-#define APACHE_AP_MMN_H
-/*
- * MODULE_MAGIC_NUMBER_MAJOR
+ * #MODULE_MAGIC_NUMBER_MAJOR\n
* Major API changes that could cause compatibility problems for older modules
* such as structure size changes. No binary compatibility is possible across
* a change in the major version.
*
- * MODULE_MAGIC_NUMBER_MINOR
+ * #MODULE_MAGIC_NUMBER_MINOR\n
* Minor API changes that do not cause binary compatibility problems.
* Should be reset to 0 when upgrading MODULE_MAGIC_NUMBER_MAJOR.
*
- * See the AP_MODULE_MAGIC_AT_LEAST macro below for an example.
+ * See the #AP_MODULE_MAGIC_AT_LEAST macro below for an example.
+ * @{
*/
+#ifndef APACHE_AP_MMN_H
+#define APACHE_AP_MMN_H
+
/*
* 20010224 (2.0.13-dev) MODULE_MAGIC_COOKIE reset to "AP20"
* 20010523 (2.0.19-dev) bump for scoreboard structure reordering
@@ -494,17 +492,17 @@
* #endif
* \endcode
*
- * @param major The major module magic number
- * @param minor The minor module magic number
- * @def AP_MODULE_MAGIC_AT_LEAST(int major, int minor)
+ * @param major The major module magic number.
+ * @param minor The minor module magic number.
*/
#define AP_MODULE_MAGIC_AT_LEAST(major,minor) \
((major) < MODULE_MAGIC_NUMBER_MAJOR \
|| ((major) == MODULE_MAGIC_NUMBER_MAJOR \
&& (minor) <= MODULE_MAGIC_NUMBER_MINOR))
-/** @deprecated present for backwards compatibility */
+/** @deprecated Present for backwards compatibility. */
#define MODULE_MAGIC_NUMBER MODULE_MAGIC_NUMBER_MAJOR
+/** @deprecated Use AP_MODULE_MAGIC_AT_LEAST. */
#define MODULE_MAGIC_AT_LEAST old_broken_macro_we_hope_you_are_not_using
#endif /* !APACHE_AP_MMN_H */