Changing comments layout preparing for generated documentation with Phpdocumentor

[lhc/web/wiklou.git] / includes / Defines.php

diff --git a/includes/Defines.php b/includes/Defines.php
index e5f5fb7..6082366 100644 (file)
--- a/includes/Defines.php
+++ b/includes/Defines.php
@@ -1,17 +1,31 @@
 <?php
-# A few constants that might be needed during LocalSettings.php
 
+/**
+ * A few constants that might be needed during LocalSettings.php
+ */
+
+/**#@+
+ * @global integer
+ */
 define( 'DBO_DEBUG', 1 );
 define( 'DBO_NOBUFFER', 2 );
 define( 'DBO_IGNORE', 4 );
 define( 'DBO_TRX', 8 );
 define( 'DBO_DEFAULT', 16 );
+/**#@- */
 
-# Virtual namespaces; these don't appear in the page database:
+/**#@+
+ * Virtual namespaces; these don't appear in the page database
+ * @global integer
+ */
 define('NS_MEDIA', -2);
 define('NS_SPECIAL', -1);
+/**#@- */
 
-# Real namespaces:
+/**#@+
+ * Real namespaces
+ * @global integer
+ */
 define('NS_MAIN', 0);
 define('NS_TALK', 1);
 define('NS_USER', 2);
@@ -28,11 +42,16 @@ define('NS_HELP', 12);
 define('NS_HELP_TALK', 13);
 define('NS_CATEGORY', 14);
 define('NS_CATEGORY_TALK', 15);
+/**#@- */
 
-# Fix the code and remove these...
+/**#@+
+ * Fix the code and remove these...
+ * @global integer
+ * @todo Globals that need to be removed after code cleaning
+ */
 define('NS_WP', NS_PROJECT);
 define('NS_WP_TALK', NS_PROJECT_TALK);
 define('NS_WIKIPEDIA', NS_PROJECT);
 define('NS_WIKIPEDIA_TALK', NS_PROJECT_TALK);
-
+/**#@- */
 ?>