]> 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 12079f44594208b055af93289d8bde68595a3d47..4da4c7dd1d9e2b1bc2dbe17209bd0eb43361ee95 100644 (file)
@@ -1,55 +1,26 @@
-/* ====================================================================
- * The Apache Software License, Version 1.1
+/* 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
  *
- * Copyright (c) 2000-2004 The Apache Software Foundation.  All rights
- * reserved.
+ *     http://www.apache.org/licenses/LICENSE-2.0
  *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- *
- * 1. Redistributions of source code must retain the above copyright
- *    notice, this list of conditions and the following disclaimer.
- *
- * 2. Redistributions in binary form must reproduce the above copyright
- *    notice, this list of conditions and the following disclaimer in
- *    the documentation and/or other materials provided with the
- *    distribution.
- *
- * 3. The end-user documentation included with the redistribution,
- *    if any, must include the following acknowledgment:
- *       "This product includes software developed by the
- *        Apache Software Foundation (http://www.apache.org/)."
- *    Alternately, this acknowledgment may appear in the software itself,
- *    if and wherever such third-party acknowledgments normally appear.
- *
- * 4. The names "Apache" and "Apache Software Foundation" must
- *    not be used to endorse or promote products derived from this
- *    software without prior written permission. For written
- *    permission, please contact apache@apache.org.
- *
- * 5. Products derived from this software may not be called "Apache",
- *    nor may "Apache" appear in their name, without prior written
- *    permission of the Apache Software Foundation.
- *
- * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
- * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
- * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
- * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
- * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
- * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
- * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
- * SUCH DAMAGE.
- * ====================================================================
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * @file  util_cfgtree.h
+ * @brief Config Tree Package
  *
- * This software consists of voluntary contributions made by many
- * individuals on behalf of the Apache Software Foundation.  For more
- * information on the Apache Software Foundation, please see
- * <http://www.apache.org/>.
+ * @defgroup APACHE_CORE_CONFIG_TREE Config Tree Package
+ * @ingroup  APACHE_CORE_CONFIG
+ * @{
  */
 
 #ifndef 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 */
@@ -76,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 */
@@ -98,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;
 
@@ -114,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
+/** @} */