From: Christophe Jaillet <jailletc36@apache.org>
Date: Sat, 19 Jul 2014 10:30:42 +0000 (+0000)
Subject: Improve doxygen comment.
X-Git-Tag: 2.5.0-alpha~3938
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=15415bf2471cf469fc83ec3f8f7dabb2d688b87b;p=apache

Improve doxygen comment.

Use a comment already present as the doxygen  description of the module.
Remove a useless @def.

git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1611880 13f79535-47bb-0310-9956-ffa450edef68
---

diff --git a/include/ap_mmn.h b/include/ap_mmn.h
index ea496962c1..3bb4adafd8 100644
--- a/include/ap_mmn.h
+++ b/include/ap_mmn.h
@@ -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 */