]> granicus.if.org Git - apache/blobdiff - include/util_cfgtree.h
mod_cache: Add the cache_status hook to register the final cache
[apache] / include / util_cfgtree.h
index d4fd3dee8821636f15abd76beb94aa17625d6bb1..4da4c7dd1d9e2b1bc2dbe17209bd0eb43361ee95 100644 (file)
@@ -1,8 +1,9 @@
-/* Copyright 2000-2004 Apache Software Foundation
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
+/* Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
  *
  *     http://www.apache.org/licenses/LICENSE-2.0
  *
  * limitations under the License.
  */
 
+/**
+ * @file  util_cfgtree.h
+ * @brief Config Tree Package
+ *
+ * @defgroup APACHE_CORE_CONFIG_TREE Config Tree Package
+ * @ingroup  APACHE_CORE_CONFIG
+ * @{
+ */
+
 #ifndef AP_CONFTREE_H
 #define AP_CONFTREE_H
 
 #include "ap_config.h"
 
-/**
- * @package Config Tree Package
- */
+#ifdef __cplusplus
+extern "C" {
+#endif
 
 typedef struct ap_directive_t ap_directive_t;
 
 /**
- * Structure used to build the config tree.  The config tree only stores
+ * @brief Structure used to build the config tree.  
+ *
+ * The config tree only stores
  * the directives that will be active in the running server.  Directives
- * that contain other directions, such as <Directory ...> cause a sub-level
+ * that contain other directions, such as &lt;Directory ...&gt; cause a sub-level
  * to be created, where the included directives are stored.  The closing
- * directive (</Directory>) is not stored in the tree.
+ * directive (&lt;/Directory&gt;) is not stored in the tree.
  */
 struct ap_directive_t {
     /** The current directive */
@@ -37,14 +49,11 @@ struct ap_directive_t {
     /** The arguments for the current directive, stored as a space 
      *  separated list */
     const char *args;
-    /** The next directive node in the tree
-     *  @defvar ap_directive_t *next */
+    /** The next directive node in the tree */
     struct ap_directive_t *next;
-    /** The first child node of this directive 
-     *  @defvar ap_directive_t *first_child */
+    /** The first child node of this directive */
     struct ap_directive_t *first_child;
-    /** The parent node of this directive 
-     *  @defvar ap_directive_t *parent */
+    /** The parent node of this directive */
     struct ap_directive_t *parent;
 
     /** directive's module can store add'l data here */
@@ -59,7 +68,6 @@ struct ap_directive_t {
 
 /**
  * The root of the configuration tree
- * @defvar ap_directive_t *conftree
  */
 AP_DECLARE_DATA extern ap_directive_t *ap_conftree;
 
@@ -75,4 +83,9 @@ AP_DECLARE_DATA extern ap_directive_t *ap_conftree;
 ap_directive_t *ap_add_node(ap_directive_t **parent, ap_directive_t *current, 
                             ap_directive_t *toadd, int child);
 
+#ifdef __cplusplus
+}
+#endif
+
 #endif
+/** @} */