| Index: trunk/phase3/includes/ProtectionForm.php |
| — | — | @@ -1,6 +1,8 @@ |
| 2 | 2 | <?php |
| 3 | 3 | /** |
| 4 | | - * Copyright (C) 2005 Brion Vibber <brion@pobox.com> |
| | 4 | + * Page protection |
| | 5 | + * |
| | 6 | + * Copyright © 2005 Brion Vibber <brion@pobox.com> |
| 5 | 7 | * http://www.mediawiki.org/ |
| 6 | 8 | * |
| 7 | 9 | * This program is free software; you can redistribute it and/or modify |
| — | — | @@ -17,6 +19,8 @@ |
| 18 | 20 | * with this program; if not, write to the Free Software Foundation, Inc., |
| 19 | 21 | * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
| 20 | 22 | * http://www.gnu.org/copyleft/gpl.html |
| | 23 | + * |
| | 24 | + * @file |
| 21 | 25 | */ |
| 22 | 26 | |
| 23 | 27 | /** |
| Index: trunk/phase3/includes/BagOStuff.php |
| — | — | @@ -1,31 +1,34 @@ |
| 2 | 2 | <?php |
| 3 | | -# |
| 4 | | -# Copyright (C) 2003-2004 Brion Vibber <brion@pobox.com> |
| 5 | | -# http://www.mediawiki.org/ |
| 6 | | -# |
| 7 | | -# This program is free software; you can redistribute it and/or modify |
| 8 | | -# it under the terms of the GNU General Public License as published by |
| 9 | | -# the Free Software Foundation; either version 2 of the License, or |
| 10 | | -# (at your option) any later version. |
| 11 | | -# |
| 12 | | -# This program is distributed in the hope that it will be useful, |
| 13 | | -# but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 14 | | -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 15 | | -# GNU General Public License for more details. |
| 16 | | -# |
| 17 | | -# You should have received a copy of the GNU General Public License along |
| 18 | | -# with this program; if not, write to the Free Software Foundation, Inc., |
| 19 | | -# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
| 20 | | -# http://www.gnu.org/copyleft/gpl.html |
| 21 | | - |
| 22 | 3 | /** |
| 23 | | - * @defgroup Cache Cache |
| | 4 | + * Classes to cache objects in PHP accelerators, SQL database or DBA files |
| 24 | 5 | * |
| | 6 | + * Copyright © 2003-2004 Brion Vibber <brion@pobox.com> |
| | 7 | + * http://www.mediawiki.org/ |
| | 8 | + * |
| | 9 | + * This program is free software; you can redistribute it and/or modify |
| | 10 | + * it under the terms of the GNU General Public License as published by |
| | 11 | + * the Free Software Foundation; either version 2 of the License, or |
| | 12 | + * (at your option) any later version. |
| | 13 | + * |
| | 14 | + * This program is distributed in the hope that it will be useful, |
| | 15 | + * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| | 16 | + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| | 17 | + * GNU General Public License for more details. |
| | 18 | + * |
| | 19 | + * You should have received a copy of the GNU General Public License along |
| | 20 | + * with this program; if not, write to the Free Software Foundation, Inc., |
| | 21 | + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
| | 22 | + * http://www.gnu.org/copyleft/gpl.html |
| | 23 | + * |
| 25 | 24 | * @file |
| 26 | 25 | * @ingroup Cache |
| 27 | 26 | */ |
| 28 | 27 | |
| 29 | 28 | /** |
| | 29 | + * @defgroup Cache Cache |
| | 30 | + */ |
| | 31 | + |
| | 32 | +/** |
| 30 | 33 | * interface is intended to be more or less compatible with |
| 31 | 34 | * the PHP memcached client. |
| 32 | 35 | * |
| Index: trunk/phase3/includes/RecentChange.php |
| — | — | @@ -2,6 +2,7 @@ |
| 3 | 3 | |
| 4 | 4 | /** |
| 5 | 5 | * Utility class for creating new RC entries |
| | 6 | + * |
| 6 | 7 | * mAttribs: |
| 7 | 8 | * rc_id id of the row in the recentchanges table |
| 8 | 9 | * rc_timestamp time the entry was made |
| Index: trunk/phase3/includes/MimeMagic.php |
| — | — | @@ -1,9 +1,12 @@ |
| 2 | 2 | <?php |
| 3 | | -/** Module defining helper functions for detecting and dealing with mime types. |
| | 3 | +/** |
| | 4 | + * Module defining helper functions for detecting and dealing with mime types. |
| 4 | 5 | * |
| | 6 | + * @file |
| 5 | 7 | */ |
| 6 | 8 | |
| 7 | | - /** Defines a set of well known mime types |
| | 9 | +/** |
| | 10 | + * Defines a set of well known mime types |
| 8 | 11 | * This is used as a fallback to mime.types files. |
| 9 | 12 | * An extensive list of well known mime types is provided by |
| 10 | 13 | * the file mime.types in the includes directory. |
| — | — | @@ -50,7 +53,8 @@ |
| 51 | 54 | END_STRING |
| 52 | 55 | ); |
| 53 | 56 | |
| 54 | | - /** Defines a set of well known mime info entries |
| | 57 | +/** |
| | 58 | + * Defines a set of well known mime info entries |
| 55 | 59 | * This is used as a fallback to mime.info files. |
| 56 | 60 | * An extensive list of well known mime types is provided by |
| 57 | 61 | * the file mime.info in the includes directory. |
| Index: trunk/phase3/includes/Exif.php |
| — | — | @@ -1,5 +1,7 @@ |
| 2 | 2 | <?php |
| 3 | 3 | /** |
| | 4 | + * Exif metadata reader |
| | 5 | + * |
| 4 | 6 | * This program is free software; you can redistribute it and/or modify |
| 5 | 7 | * it under the terms of the GNU General Public License as published by |
| 6 | 8 | * the Free Software Foundation; either version 2 of the License, or |
| Index: trunk/phase3/includes/proxy_check.php |
| — | — | @@ -1,6 +1,8 @@ |
| 2 | 2 | <?php |
| 3 | 3 | /** |
| 4 | 4 | * Command line script to check for an open proxy at a specified location |
| | 5 | + * |
| | 6 | + * @file |
| 5 | 7 | */ |
| 6 | 8 | |
| 7 | 9 | if( php_sapi_name() != 'cli' ) { |
| Index: trunk/phase3/includes/Sanitizer.php |
| — | — | @@ -2,7 +2,7 @@ |
| 3 | 3 | /** |
| 4 | 4 | * XHTML sanitizer for MediaWiki |
| 5 | 5 | * |
| 6 | | - * Copyright (C) 2002-2005 Brion Vibber <brion@pobox.com> et al |
| | 6 | + * Copyright © 2002-2005 Brion Vibber <brion@pobox.com> et al |
| 7 | 7 | * http://www.mediawiki.org/ |
| 8 | 8 | * |
| 9 | 9 | * This program is free software; you can redistribute it and/or modify |
| Index: trunk/phase3/includes/Hooks.php |
| — | — | @@ -1,6 +1,7 @@ |
| 2 | 2 | <?php |
| 3 | 3 | /** |
| 4 | | - * Hooks.php -- a tool for running hook functions |
| | 4 | + * A tool for running hook functions. |
| | 5 | + * |
| 5 | 6 | * Copyright 2004, 2005 Evan Prodromou <evan@wikitravel.org>. |
| 6 | 7 | * |
| 7 | 8 | * This program is free software; you can redistribute it and/or modify |
| — | — | @@ -24,9 +25,15 @@ |
| 25 | 26 | |
| 26 | 27 | |
| 27 | 28 | /** |
| | 29 | + * Call hook functions defined in $wgHooks |
| | 30 | + * |
| 28 | 31 | * Because programmers assign to $wgHooks, we need to be very |
| 29 | 32 | * careful about its contents. So, there's a lot more error-checking |
| 30 | 33 | * in here than would normally be necessary. |
| | 34 | + * |
| | 35 | + * @param $event String: event name |
| | 36 | + * @param $args Array: parameters passed to hook functions |
| | 37 | + * @return Boolean |
| 31 | 38 | */ |
| 32 | 39 | function wfRunHooks($event, $args = array()) { |
| 33 | 40 | |
| Index: trunk/phase3/includes/AutoLoader.php |
| — | — | @@ -1,9 +1,15 @@ |
| 2 | 2 | <?php |
| 3 | | -/* This defines autoloading handler for whole MediaWiki framework */ |
| | 3 | +/** |
| | 4 | + * This defines autoloading handler for whole MediaWiki framework |
| | 5 | + * |
| | 6 | + * @file |
| | 7 | + */ |
| 4 | 8 | |
| 5 | | -# Locations of core classes |
| 6 | | -# Extension classes are specified with $wgAutoloadClasses |
| 7 | | -# This array is a global instead of a static member of AutoLoader to work around a bug in APC |
| | 9 | +/** |
| | 10 | + * Locations of core classes |
| | 11 | + * Extension classes are specified with $wgAutoloadClasses |
| | 12 | + * This array is a global instead of a static member of AutoLoader to work around a bug in APC |
| | 13 | + */ |
| 8 | 14 | global $wgAutoloadLocalClasses; |
| 9 | 15 | |
| 10 | 16 | $wgAutoloadLocalClasses = array( |
| Index: trunk/phase3/includes/AjaxFunctions.php |
| — | — | @@ -1,5 +1,7 @@ |
| 2 | 2 | <?php |
| 3 | 3 | /** |
| | 4 | + * Handler functions for Ajax requests |
| | 5 | + * |
| 4 | 6 | * @file |
| 5 | 7 | * @ingroup Ajax |
| 6 | 8 | */ |
| Index: trunk/phase3/includes/MagicWord.php |
| — | — | @@ -1,6 +1,7 @@ |
| 2 | 2 | <?php |
| 3 | 3 | /** |
| 4 | 4 | * File for magic words |
| | 5 | + * |
| 5 | 6 | * See docs/magicword.txt |
| 6 | 7 | * |
| 7 | 8 | * @file |
| Index: trunk/phase3/includes/ImportXMLReader.php |
| — | — | @@ -1,5 +1,11 @@ |
| 2 | 2 | <?php |
| 3 | 3 | /** |
| | 4 | + * XML file reader for the page data importer |
| | 5 | + * |
| | 6 | + * @file |
| | 7 | + */ |
| | 8 | + |
| | 9 | +/** |
| 4 | 10 | * implements Special:Import |
| 5 | 11 | * @ingroup SpecialPage |
| 6 | 12 | */ |
| Index: trunk/phase3/includes/RawPage.php |
| — | — | @@ -1,7 +1,10 @@ |
| 2 | 2 | <?php |
| 3 | 3 | /** |
| 4 | | - * Copyright (C) 2004 Gabriel Wicke <wicke@wikidev.net> |
| | 4 | + * Raw page text accessor |
| | 5 | + * |
| | 6 | + * Copyright © 2004 Gabriel Wicke <wicke@wikidev.net> |
| 5 | 7 | * http://wikidev.net/ |
| | 8 | + * |
| 6 | 9 | * Based on HistoryPage and SpecialExport |
| 7 | 10 | * |
| 8 | 11 | * License: GPL (http://www.gnu.org/copyleft/gpl.html) |
| Index: trunk/phase3/includes/SkinTemplate.php |
| — | — | @@ -1,22 +1,28 @@ |
| 2 | 2 | <?php |
| | 3 | +/** |
| | 4 | + * Base class for template-based skins |
| | 5 | + * |
| | 6 | + * This program is free software; you can redistribute it and/or modify |
| | 7 | + * it under the terms of the GNU General Public License as published by |
| | 8 | + * the Free Software Foundation; either version 2 of the License, or |
| | 9 | + * (at your option) any later version. |
| | 10 | + * |
| | 11 | + * This program is distributed in the hope that it will be useful, |
| | 12 | + * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| | 13 | + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| | 14 | + * GNU General Public License for more details. |
| | 15 | + * |
| | 16 | + * You should have received a copy of the GNU General Public License along |
| | 17 | + * with this program; if not, write to the Free Software Foundation, Inc., |
| | 18 | + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
| | 19 | + * http://www.gnu.org/copyleft/gpl.html |
| | 20 | + * |
| | 21 | + * @file |
| | 22 | + */ |
| | 23 | + |
| 3 | 24 | if ( ! defined( 'MEDIAWIKI' ) ) |
| 4 | 25 | die( 1 ); |
| 5 | 26 | |
| 6 | | -# This program is free software; you can redistribute it and/or modify |
| 7 | | -# it under the terms of the GNU General Public License as published by |
| 8 | | -# the Free Software Foundation; either version 2 of the License, or |
| 9 | | -# (at your option) any later version. |
| 10 | | -# |
| 11 | | -# This program is distributed in the hope that it will be useful, |
| 12 | | -# but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 13 | | -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 14 | | -# GNU General Public License for more details. |
| 15 | | -# |
| 16 | | -# You should have received a copy of the GNU General Public License along |
| 17 | | -# with this program; if not, write to the Free Software Foundation, Inc., |
| 18 | | -# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
| 19 | | -# http://www.gnu.org/copyleft/gpl.html |
| 20 | | - |
| 21 | 27 | /** |
| 22 | 28 | * Wrapper object for MediaWiki's localization functions, |
| 23 | 29 | * to be passed to the template engine. |
| Index: trunk/phase3/includes/WikiError.php |
| — | — | @@ -1,7 +1,8 @@ |
| 2 | 2 | <?php |
| 3 | 3 | /** |
| 4 | 4 | * MediaWiki error classes |
| 5 | | - * Copyright (C) 2005 Brion Vibber <brion@pobox.com> |
| | 5 | + * |
| | 6 | + * Copyright © 2005 Brion Vibber <brion@pobox.com> |
| 6 | 7 | * http://www.mediawiki.org/ |
| 7 | 8 | * |
| 8 | 9 | * This program is free software; you can redistribute it and/or modify |
| — | — | @@ -19,6 +20,7 @@ |
| 20 | 21 | * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
| 21 | 22 | * http://www.gnu.org/copyleft/gpl.html |
| 22 | 23 | * |
| | 24 | + * @file |
| 23 | 25 | */ |
| 24 | 26 | |
| 25 | 27 | /** |
| Index: trunk/phase3/includes/Metadata.php |
| — | — | @@ -1,6 +1,7 @@ |
| 2 | 2 | <?php |
| 3 | 3 | /** |
| 4 | | - * Metadata.php -- provides DublinCore and CreativeCommons metadata |
| | 4 | + * Provides DublinCore and CreativeCommons metadata |
| | 5 | + * |
| 5 | 6 | * Copyright 2004, Evan Prodromou <evan@wikitravel.org>. |
| 6 | 7 | * |
| 7 | 8 | * This program is free software; you can redistribute it and/or modify |
| — | — | @@ -18,6 +19,7 @@ |
| 19 | 20 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA |
| 20 | 21 | * |
| 21 | 22 | * @author Evan Prodromou <evan@wikitravel.org> |
| | 23 | + * @file |
| 22 | 24 | */ |
| 23 | 25 | |
| 24 | 26 | abstract class RdfMetaData { |
| Index: trunk/phase3/includes/Credits.php |
| — | — | @@ -1,22 +1,24 @@ |
| 2 | 2 | <?php |
| 3 | 3 | /** |
| 4 | | - * Credits.php -- formats credits for articles |
| | 4 | + * Formats credits for articles |
| | 5 | + * |
| 5 | 6 | * Copyright 2004, Evan Prodromou <evan@wikitravel.org>. |
| 6 | 7 | * |
| 7 | | - * This program is free software; you can redistribute it and/or modify |
| 8 | | - * it under the terms of the GNU General Public License as published by |
| 9 | | - * the Free Software Foundation; either version 2 of the License, or |
| 10 | | - * (at your option) any later version. |
| | 8 | + * This program is free software; you can redistribute it and/or modify |
| | 9 | + * it under the terms of the GNU General Public License as published by |
| | 10 | + * the Free Software Foundation; either version 2 of the License, or |
| | 11 | + * (at your option) any later version. |
| 11 | 12 | * |
| 12 | | - * This program is distributed in the hope that it will be useful, |
| 13 | | - * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 14 | | - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 15 | | - * GNU General Public License for more details. |
| | 13 | + * This program is distributed in the hope that it will be useful, |
| | 14 | + * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| | 15 | + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| | 16 | + * GNU General Public License for more details. |
| 16 | 17 | * |
| 17 | | - * You should have received a copy of the GNU General Public License |
| 18 | | - * along with this program; if not, write to the Free Software |
| 19 | | - * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA |
| | 18 | + * You should have received a copy of the GNU General Public License |
| | 19 | + * along with this program; if not, write to the Free Software |
| | 20 | + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA |
| 20 | 21 | * |
| | 22 | + * @file |
| 21 | 23 | * @author <evan@wikitravel.org> |
| 22 | 24 | */ |
| 23 | 25 | |
| Index: trunk/phase3/includes/Import.php |
| — | — | @@ -1,7 +1,8 @@ |
| 2 | 2 | <?php |
| 3 | 3 | /** |
| 4 | 4 | * MediaWiki page data importer |
| 5 | | - * Copyright (C) 2003,2005 Brion Vibber <brion@pobox.com> |
| | 5 | + * |
| | 6 | + * Copyright © 2003,2005 Brion Vibber <brion@pobox.com> |
| 6 | 7 | * http://www.mediawiki.org/ |
| 7 | 8 | * |
| 8 | 9 | * This program is free software; you can redistribute it and/or modify |
| — | — | @@ -24,7 +25,7 @@ |
| 25 | 26 | */ |
| 26 | 27 | |
| 27 | 28 | /** |
| 28 | | - * |
| | 29 | + * @todo document (e.g. one-sentence class description). |
| 29 | 30 | * @ingroup SpecialPage |
| 30 | 31 | */ |
| 31 | 32 | class WikiRevision { |
| Index: trunk/phase3/includes/RevisionDelete.php |
| — | — | @@ -1,5 +1,11 @@ |
| 2 | 2 | <?php |
| 3 | 3 | /** |
| | 4 | + * Revision/log/file deletion backend |
| | 5 | + * |
| | 6 | + * @file |
| | 7 | + */ |
| | 8 | + |
| | 9 | +/** |
| 4 | 10 | * Temporary b/c interface, collection of static functions. |
| 5 | 11 | * @ingroup SpecialPage |
| 6 | 12 | */ |
| Index: trunk/phase3/includes/Exception.php |
| — | — | @@ -1,10 +1,17 @@ |
| 2 | 2 | <?php |
| 3 | 3 | /** |
| | 4 | + * Exception class and handler |
| | 5 | + * |
| | 6 | + * @file |
| | 7 | + */ |
| | 8 | + |
| | 9 | +/** |
| 4 | 10 | * @defgroup Exception Exception |
| 5 | 11 | */ |
| 6 | 12 | |
| 7 | 13 | /** |
| 8 | 14 | * MediaWiki exception |
| | 15 | + * |
| 9 | 16 | * @ingroup Exception |
| 10 | 17 | */ |
| 11 | 18 | class MWException extends Exception { |
| Index: trunk/phase3/includes/AjaxResponse.php |
| — | — | @@ -1,5 +1,7 @@ |
| 2 | 2 | <?php |
| 3 | 3 | /** |
| | 4 | + * Response handler for Ajax requests |
| | 5 | + * |
| 4 | 6 | * @file |
| 5 | 7 | * @ingroup Ajax |
| 6 | 8 | */ |
| Index: trunk/phase3/includes/IP.php |
| — | — | @@ -1,7 +1,10 @@ |
| 2 | 2 | <?php |
| 3 | | -/* |
| 4 | | - * @Author "Ashar Voultoiz" <hashar@altern.org> |
| 5 | | - * @License GPL v2 or later |
| | 3 | +/** |
| | 4 | + * Functions and constants to play with IP addresses and ranges |
| | 5 | + * |
| | 6 | + * @file |
| | 7 | + * @author "Ashar Voultoiz" <hashar@altern.org> |
| | 8 | + * @license GPL v2 or later |
| 6 | 9 | */ |
| 7 | 10 | |
| 8 | 11 | // Some regex definition to "play" with IP address and IP address blocks |
| Index: trunk/phase3/includes/DjVuImage.php |
| — | — | @@ -1,8 +1,8 @@ |
| 2 | 2 | <?php |
| 3 | | - |
| 4 | 3 | /** |
| | 4 | + * DjVu image handler |
| 5 | 5 | * |
| 6 | | - * Copyright (C) 2006 Brion Vibber <brion@pobox.com> |
| | 6 | + * Copyright © 2006 Brion Vibber <brion@pobox.com> |
| 7 | 7 | * http://www.mediawiki.org/ |
| 8 | 8 | * |
| 9 | 9 | * This program is free software; you can redistribute it and/or modify |
| — | — | @@ -20,6 +20,7 @@ |
| 21 | 21 | * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
| 22 | 22 | * http://www.gnu.org/copyleft/gpl.html |
| 23 | 23 | * |
| | 24 | + * @file |
| 24 | 25 | */ |
| 25 | 26 | |
| 26 | 27 | /** |