From 5be509b0c16ec1af1a3014f60b57a0f796079d86 Mon Sep 17 00:00:00 2001 From: Alexandre Emsenhuber Date: Sun, 8 Aug 2010 14:23:14 +0000 Subject: [PATCH] * Standardised file description headers * Added some descriptions * Added @file where needed --- includes/AjaxFunctions.php | 2 ++ includes/AjaxResponse.php | 2 ++ includes/AutoLoader.php | 16 +++++++++----- includes/BagOStuff.php | 43 +++++++++++++++++++----------------- includes/Credits.php | 26 ++++++++++++---------- includes/DjVuImage.php | 5 +++-- includes/Exception.php | 7 ++++++ includes/Exif.php | 2 ++ includes/Hooks.php | 9 +++++++- includes/IP.php | 9 +++++--- includes/Import.php | 5 +++-- includes/ImportXMLReader.php | 6 +++++ includes/MagicWord.php | 1 + includes/Metadata.php | 4 +++- includes/MimeMagic.php | 10 ++++++--- includes/ProtectionForm.php | 6 ++++- includes/RawPage.php | 5 ++++- includes/RecentChange.php | 1 + includes/RevisionDelete.php | 6 +++++ includes/Sanitizer.php | 2 +- includes/SkinTemplate.php | 36 +++++++++++++++++------------- includes/WikiError.php | 4 +++- includes/proxy_check.php | 2 ++ 23 files changed, 141 insertions(+), 68 deletions(-) diff --git a/includes/AjaxFunctions.php b/includes/AjaxFunctions.php index c8018149a9..8e5de31b73 100644 --- a/includes/AjaxFunctions.php +++ b/includes/AjaxFunctions.php @@ -1,5 +1,7 @@ -# 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 + * 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. diff --git a/includes/Credits.php b/includes/Credits.php index 53718cb0bc..e4c8be54e2 100644 --- a/includes/Credits.php +++ b/includes/Credits.php @@ -1,22 +1,24 @@ . * - * 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 */ diff --git a/includes/DjVuImage.php b/includes/DjVuImage.php index 842b3a9e1b..576991b9ce 100644 --- a/includes/DjVuImage.php +++ b/includes/DjVuImage.php @@ -1,8 +1,8 @@ + * Copyright © 2006 Brion Vibber * 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 */ /** diff --git a/includes/Exception.php b/includes/Exception.php index 487730b318..0b77322db7 100644 --- a/includes/Exception.php +++ b/includes/Exception.php @@ -1,10 +1,17 @@ . * * This program is free software; you can redistribute it and/or modify @@ -24,9 +25,15 @@ /** + * 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()) { diff --git a/includes/IP.php b/includes/IP.php index 490ed7ea7f..eb81f464dc 100644 --- a/includes/IP.php +++ b/includes/IP.php @@ -1,7 +1,10 @@ - * @License GPL v2 or later +/** + * Functions and constants to play with IP addresses and ranges + * + * @file + * @author "Ashar Voultoiz" + * @license GPL v2 or later */ // Some regex definition to "play" with IP address and IP address blocks diff --git a/includes/Import.php b/includes/Import.php index 605fd81d90..fd33e037bb 100644 --- a/includes/Import.php +++ b/includes/Import.php @@ -1,7 +1,8 @@ + * + * Copyright © 2003,2005 Brion Vibber * 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 { diff --git a/includes/ImportXMLReader.php b/includes/ImportXMLReader.php index cdb7f7f218..9a9e6c4409 100644 --- a/includes/ImportXMLReader.php +++ b/includes/ImportXMLReader.php @@ -1,4 +1,10 @@ . * * 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 + * @file */ abstract class RdfMetaData { diff --git a/includes/MimeMagic.php b/includes/MimeMagic.php index 8c939e0df3..813db381d7 100644 --- a/includes/MimeMagic.php +++ b/includes/MimeMagic.php @@ -1,9 +1,12 @@ + * Page protection + * + * Copyright © 2005 Brion Vibber * 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 */ /** diff --git a/includes/RawPage.php b/includes/RawPage.php index 1d1b9d0d23..a3b4fc2acb 100644 --- a/includes/RawPage.php +++ b/includes/RawPage.php @@ -1,7 +1,10 @@ + * Raw page text accessor + * + * Copyright © 2004 Gabriel Wicke * http://wikidev.net/ + * * Based on HistoryPage and SpecialExport * * License: GPL (http://www.gnu.org/copyleft/gpl.html) diff --git a/includes/RecentChange.php b/includes/RecentChange.php index 81e3b128ec..6663d58a5d 100644 --- a/includes/RecentChange.php +++ b/includes/RecentChange.php @@ -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 diff --git a/includes/RevisionDelete.php b/includes/RevisionDelete.php index 4d2957e85b..2940b9f0e9 100644 --- a/includes/RevisionDelete.php +++ b/includes/RevisionDelete.php @@ -1,4 +1,10 @@ et al + * Copyright © 2002-2005 Brion Vibber et al * http://www.mediawiki.org/ * * This program is free software; you can redistribute it and/or modify diff --git a/includes/SkinTemplate.php b/includes/SkinTemplate.php index e14674bda9..50dfefe24e 100644 --- a/includes/SkinTemplate.php +++ b/includes/SkinTemplate.php @@ -1,22 +1,28 @@ + * + * Copyright © 2005 Brion Vibber * 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 */ /** diff --git a/includes/proxy_check.php b/includes/proxy_check.php index 61995fea42..2bc46c0d21 100644 --- a/includes/proxy_check.php +++ b/includes/proxy_check.php @@ -1,6 +1,8 @@