Document the weird semantics of ap_find_command_in_modules()

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

diff --git a/include/http_config.h b/include/http_config.h
index 4c5098af59864d563debf9fabba357e4c210fa7c..ab7de2792b632f2e1e1571f8d548e14c95ef9a7d 100644 (file)
--- a/include/http_config.h
+++ b/include/http_config.h
@@ -1169,10 +1169,13 @@ AP_CORE_DECLARE(const command_rec *) ap_find_command(const char *name,
                                                      const command_rec *cmds);
 
 /**
- * Find a given directive in a list module
+ * Find a given directive in a list of modules.
  * @param cmd_name The directive to search for
- * @param mod The module list to search
- * @return The directive definition of the specified directive
+ * @param mod Pointer to the first module in the linked list; will be set to
+ *            the module providing cmd_name
+ * @return The directive definition of the specified directive.
+ *         *mod will be changed to point to the module containing the
+ *         directive.
  */
 AP_CORE_DECLARE(const command_rec *) ap_find_command_in_modules(const char *cmd_name,
                                                                 module **mod);