* Standardised file description headers
authorAlexandre Emsenhuber <ialex@users.mediawiki.org>
Sun, 8 Aug 2010 14:23:14 +0000 (14:23 +0000)
committerAlexandre Emsenhuber <ialex@users.mediawiki.org>
Sun, 8 Aug 2010 14:23:14 +0000 (14:23 +0000)
* Added some descriptions
* Added @file where needed

23 files changed:
includes/AjaxFunctions.php
includes/AjaxResponse.php
includes/AutoLoader.php
includes/BagOStuff.php
includes/Credits.php
includes/DjVuImage.php
includes/Exception.php
includes/Exif.php
includes/Hooks.php
includes/IP.php
includes/Import.php
includes/ImportXMLReader.php
includes/MagicWord.php
includes/Metadata.php
includes/MimeMagic.php
includes/ProtectionForm.php
includes/RawPage.php
includes/RecentChange.php
includes/RevisionDelete.php
includes/Sanitizer.php
includes/SkinTemplate.php
includes/WikiError.php
includes/proxy_check.php

index c801814..8e5de31 100644 (file)
@@ -1,5 +1,7 @@
 <?php
 /**
+ * Handler functions for Ajax requests
+ *
  * @file
  * @ingroup Ajax
  */
index f5f0834..22b33a4 100644 (file)
@@ -1,5 +1,7 @@
 <?php
 /**
+ * Response handler for Ajax requests
+ *
  * @file
  * @ingroup Ajax
  */
index 0ec2b04..bc0e477 100644 (file)
@@ -1,9 +1,15 @@
 <?php
-/* This defines autoloading handler for whole MediaWiki framework */
-
-# Locations of core classes
-# Extension classes are specified with $wgAutoloadClasses
-# This array is a global instead of a static member of AutoLoader to work around a bug in APC
+/**
+ * This defines autoloading handler for whole MediaWiki framework
+ *
+ * @file
+ */
+
+/**
+ * Locations of core classes
+ * Extension classes are specified with $wgAutoloadClasses
+ * This array is a global instead of a static member of AutoLoader to work around a bug in APC
+ */
 global $wgAutoloadLocalClasses;
 
 $wgAutoloadLocalClasses = array(
index 2e2ba01..5482dcd 100644 (file)
@@ -1,30 +1,33 @@
 <?php
-#
-# Copyright (C) 2003-2004 Brion Vibber <brion@pobox.com>
-# http://www.mediawiki.org/
-#
-# This program is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 2 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License along
-# with this program; if not, write to the Free Software Foundation, Inc.,
-# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
-# http://www.gnu.org/copyleft/gpl.html
-
 /**
- * @defgroup Cache Cache
+ * Classes to cache objects in PHP accelerators, SQL database or DBA files
+ *
+ * Copyright © 2003-2004 Brion Vibber <brion@pobox.com>
+ * http://www.mediawiki.org/
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
  *
  * @file
  * @ingroup Cache
  */
 
+/**
+ * @defgroup Cache Cache
+ */
+
 /**
  * interface is intended to be more or less compatible with
  * the PHP memcached client.
index 53718cb..e4c8be5 100644 (file)
@@ -1,22 +1,24 @@
 <?php
 /**
- * Credits.php -- formats credits for articles
+ * Formats credits for articles
+ *
  * Copyright 2004, Evan Prodromou <evan@wikitravel.org>.
  *
- *  This program is free software; you can redistribute it and/or modify
- *  it under the terms of the GNU General Public License as published by
- *  the Free Software Foundation; either version 2 of the License, or
- *  (at your option) any later version.
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
  *
- *  This program is distributed in the hope that it will be useful,
- *  but WITHOUT ANY WARRANTY; without even the implied warranty of
- *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- *  GNU General Public License for more details.
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
  *
- *  You should have received a copy of the GNU General Public License
- *  along with this program; if not, write to the Free Software
- *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
  *
+ * @file
  * @author <evan@wikitravel.org>
  */
 
index 842b3a9..576991b 100644 (file)
@@ -1,8 +1,8 @@
 <?php
-
 /**
+ * DjVu image handler
  *
- * Copyright (C) 2006 Brion Vibber <brion@pobox.com>
+ * Copyright © 2006 Brion Vibber <brion@pobox.com>
  * http://www.mediawiki.org/
  *
  * This program is free software; you can redistribute it and/or modify
@@ -20,6 +20,7 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
+ * @file
  */
 
 /**
index 487730b..0b77322 100644 (file)
@@ -1,10 +1,17 @@
 <?php
+/**
+ * Exception class and handler
+ *
+ * @file
+ */
+
 /**
  * @defgroup Exception Exception
  */
 
 /**
  * MediaWiki exception
+ *
  * @ingroup Exception
  */
 class MWException extends Exception {
index 2b48eab..50a3361 100644 (file)
@@ -1,5 +1,7 @@
 <?php
 /**
+ * Exif metadata reader
+ *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
index 0b2dc5f..37e4e41 100644 (file)
@@ -1,6 +1,7 @@
 <?php
 /**
- * Hooks.php -- a tool for running hook functions
+ * A tool for running hook functions.
+ *
  * Copyright 2004, 2005 Evan Prodromou <evan@wikitravel.org>.
  *
  *  This program is free software; you can redistribute it and/or modify
 
 
 /**
+ * Call hook functions defined in $wgHooks
+ *
  * Because programmers assign to $wgHooks, we need to be very
  * careful about its contents. So, there's a lot more error-checking
  * in here than would normally be necessary.
+ *
+ * @param $event String: event name
+ * @param $args Array: parameters passed to hook functions
+ * @return Boolean
  */
 function wfRunHooks($event, $args = array()) {
 
index 490ed7e..eb81f46 100644 (file)
@@ -1,7 +1,10 @@
 <?php
-/*
- * @Author "Ashar Voultoiz" <hashar@altern.org>
- * @License GPL v2 or later
+/**
+ * Functions and constants to play with IP addresses and ranges
+ *
+ * @file
+ * @author "Ashar Voultoiz" <hashar@altern.org>
+ * @license GPL v2 or later
  */
 
 // Some regex definition to "play" with IP address and IP address blocks
index 605fd81..fd33e03 100644 (file)
@@ -1,7 +1,8 @@
 <?php
 /**
  * MediaWiki page data importer
- * Copyright (C) 2003,2005 Brion Vibber <brion@pobox.com>
+ *
+ * Copyright © 2003,2005 Brion Vibber <brion@pobox.com>
  * http://www.mediawiki.org/
  *
  * This program is free software; you can redistribute it and/or modify
@@ -24,7 +25,7 @@
  */
 
 /**
- *
+ * @todo document (e.g. one-sentence class description).
  * @ingroup SpecialPage
  */
 class WikiRevision {
index cdb7f7f..9a9e6c4 100644 (file)
@@ -1,4 +1,10 @@
 <?php
+/**
+ * XML file reader for the page data importer
+ *
+ * @file
+ */
+
 /**
  * implements Special:Import
  * @ingroup SpecialPage
index 133afb3..a0bcd8c 100644 (file)
@@ -1,6 +1,7 @@
 <?php
 /**
  * File for magic words
+ *
  * See docs/magicword.txt
  *
  * @file
index f3b32e0..bd24249 100644 (file)
@@ -1,6 +1,7 @@
 <?php
 /**
- * Metadata.php -- provides DublinCore and CreativeCommons metadata
+ * Provides DublinCore and CreativeCommons metadata
+ *
  * Copyright 2004, Evan Prodromou <evan@wikitravel.org>.
  *
  *  This program is free software; you can redistribute it and/or modify
@@ -18,6 +19,7 @@
  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
  *
  * @author Evan Prodromou <evan@wikitravel.org>
+ * @file
  */
 
 abstract class RdfMetaData {
index 8c939e0..813db38 100644 (file)
@@ -1,9 +1,12 @@
 <?php
-/** Module defining helper functions for detecting and dealing with mime types.
+/**
+ * Module defining helper functions for detecting and dealing with mime types.
  *
+ * @file
  */
 
- /** Defines a set of well known mime types
+/**
+ * Defines a set of well known mime types
  * This is used as a fallback to mime.types files.
  * An extensive list of well known mime types is provided by
  * the file mime.types in the includes directory.
@@ -50,7 +53,8 @@ video/mpeg mpg mpeg
 END_STRING
 );
 
- /** Defines a set of well known mime info entries
+/**
+ * Defines a set of well known mime info entries
  * This is used as a fallback to mime.info files.
  * An extensive list of well known mime types is provided by
  * the file mime.info in the includes directory.
index 41436a5..655b0be 100644 (file)
@@ -1,6 +1,8 @@
 <?php
 /**
- * Copyright (C) 2005 Brion Vibber <brion@pobox.com>
+ * Page protection
+ *
+ * Copyright © 2005 Brion Vibber <brion@pobox.com>
  * http://www.mediawiki.org/
  *
  * This program is free software; you can redistribute it and/or modify
@@ -17,6 +19,8 @@
  * with this program; if not, write to the Free Software Foundation, Inc.,
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
  */
 
 /**
index 1d1b9d0..a3b4fc2 100644 (file)
@@ -1,7 +1,10 @@
 <?php
 /**
- * Copyright (C) 2004 Gabriel Wicke <wicke@wikidev.net>
+ * Raw page text accessor
+ *
+ * Copyright © 2004 Gabriel Wicke <wicke@wikidev.net>
  * http://wikidev.net/
+ *
  * Based on HistoryPage and SpecialExport
  *
  * License: GPL (http://www.gnu.org/copyleft/gpl.html)
index 81e3b12..6663d58 100644 (file)
@@ -2,6 +2,7 @@
 
 /**
  * Utility class for creating new RC entries
+ *
  * mAttribs:
  *  rc_id           id of the row in the recentchanges table
  *  rc_timestamp    time the entry was made
index 4d2957e..2940b9f 100644 (file)
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Revision/log/file deletion backend
+ *
+ * @file
+ */
+
 /**
  * Temporary b/c interface, collection of static functions.
  * @ingroup SpecialPage
index 5b6f2da..e8a3a38 100644 (file)
@@ -2,7 +2,7 @@
 /**
  * XHTML sanitizer for MediaWiki
  *
- * Copyright (C) 2002-2005 Brion Vibber <brion@pobox.com> et al
+ * Copyright © 2002-2005 Brion Vibber <brion@pobox.com> et al
  * http://www.mediawiki.org/
  *
  * This program is free software; you can redistribute it and/or modify
index e14674b..50dfefe 100644 (file)
@@ -1,22 +1,28 @@
 <?php
+/**
+ * Base class for template-based skins
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ */
+
 if ( ! defined( 'MEDIAWIKI' ) )
        die( 1 );
 
-# This program is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 2 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License along
-# with this program; if not, write to the Free Software Foundation, Inc.,
-# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
-# http://www.gnu.org/copyleft/gpl.html
-
 /**
  * Wrapper object for MediaWiki's localization functions,
  * to be passed to the template engine.
index 251c174..726a79c 100644 (file)
@@ -1,7 +1,8 @@
 <?php
 /**
  * MediaWiki error classes
- * Copyright (C) 2005 Brion Vibber <brion@pobox.com>
+ *
+ * Copyright © 2005 Brion Vibber <brion@pobox.com>
  * http://www.mediawiki.org/
  *
  * This program is free software; you can redistribute it and/or modify
@@ -19,6 +20,7 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
+ * @file
  */
 
 /**
index 61995fe..2bc46c0 100644 (file)
@@ -1,6 +1,8 @@
 <?php
 /**
  * Command line script to check for an open proxy at a specified location
+ *
+ * @file
  */
 
 if( php_sapi_name() != 'cli' ) {