Wrapped certain tricky constructs in @cond/@endcond to prevent Doxygen
authorFran Rogers <krimpet@users.mediawiki.org>
Wed, 6 Aug 2008 03:55:49 +0000 (03:55 +0000)
committerFran Rogers <krimpet@users.mediawiki.org>
Wed, 6 Aug 2008 03:55:49 +0000 (03:55 +0000)
from choking on them and segfaulting.

includes/GlobalFunctions.php
includes/SiteConfiguration.php
includes/api/ApiFormatJson_json.php

index c5d5f1f..cfdec5c 100644 (file)
@@ -12,6 +12,9 @@ require_once dirname(__FILE__) . '/LogPage.php';
 require_once dirname(__FILE__) . '/normal/UtfNormalUtil.php';
 require_once dirname(__FILE__) . '/XmlFunctions.php';
 
+// Hide compatibility functions from Doxygen
+/// @cond
+
 /**
  * Compatibility functions
  *
@@ -87,6 +90,9 @@ if ( !function_exists( 'array_diff_key' ) ) {
        }
 }
 
+/// @endcond
+
+
 /**
  * Like array_diff( $a, $b ) except that it works with two-dimensional arrays.
  */
index 6cdd508..73aae1a 100644 (file)
@@ -5,8 +5,12 @@
  * meaning that require_once() fails to detect that it is including the same
  * file again. We use DIY C-style protection as a workaround.
  */
+
+// Hide this pattern from Doxygen, which spazzes out at it
+/// @cond
 if (!defined('SITE_CONFIGURATION')) {
 define('SITE_CONFIGURATION', 1);
+/// @endcond
 
 /**
  * This is a class used to hold configuration settings, particularly for multi-wiki sites.
index 2418f02..9714ab8 100644 (file)
@@ -812,6 +812,9 @@ class Services_JSON
     }
 }
 
+
+// Hide the PEAR_Error variant from Doxygen
+/// @cond
 if (class_exists('PEAR_Error')) {
 
     /**
@@ -827,6 +830,7 @@ if (class_exists('PEAR_Error')) {
     }
 
 } else {
+/// @endcond
 
     /**
      * @todo Ultimately, this class shall be descended from PEAR_Error