Removed the 'eclipse helper' bit on top of every API module

It's a parctice that dates back to 2006 when the API was first written, and frankly isn't covered by the coding conventions. Same thing with the docblocks, they're all copypasted with some bits changed and don't even make sense if you look at them in the genereated code docs.
I don't feel that any of us depend on this anymore (get a better IDE), so in the inerest of consistancy it's time we said goodbye to it.
This commit is contained in:
John Du Hart 2011-11-16 00:17:26 +00:00
parent 018d885f64
commit 2e7d867478
81 changed files with 0 additions and 402 deletions

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( "ApiBase.php" );
}
/**
* API module that facilitates the blocking of users. Requires API write mode
* to be enabled.

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( "ApiBase.php" );
}
/**
* API module that facilitates deleting pages. The API equivalent of action=delete.
* Requires API write mode to be enabled.

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( "ApiBase.php" );
}
/**
* API module that dies with an error immediately.
*

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( "ApiBase.php" );
}
/**
* A module that allows for editing and creating pages.
*

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( "ApiBase.php" );
}
/**
* API Module to facilitate sending of emails to users
* @ingroup API

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( "ApiBase.php" );
}
/**
* API module that functions as a shortcut to the wikitext preprocessor. Expands
* any templates in a provided string, and returns the result of this expansion

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( "ApiBase.php" );
}
/**
* This action allows users to get their watchlist items in RSS/Atom formats.
* When executed, it performs a nested call to the API to get the needed data,

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( "ApiBase.php" );
}
/**
* @ingroup API
*/

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( 'ApiBase.php' );
}
/**
* This is the abstract base class for API formatters.
*

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( 'ApiFormatBase.php' );
}
/**
* API PHP's var_export() output formatter
* @ingroup API

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( 'ApiFormatBase.php' );
}
/**
* API PHP's var_dump() output formatter
* @ingroup API

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( 'ApiFormatBase.php' );
}
/**
* API JSON output formatter
* @ingroup API

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( 'ApiFormatBase.php' );
}
/**
* API Serialized PHP output formatter
* @ingroup API

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( 'ApiFormatBase.php' );
}
/**
* Formatter that spits out anything you like with any desired MIME type
* @ingroup API

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( 'ApiFormatBase.php' );
}
/**
* API Text output formatter
* @ingroup API

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( 'ApiFormatBase.php' );
}
/**
* API WDDX output formatter
* @ingroup API

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( 'ApiFormatBase.php' );
}
/**
* API XML output formatter
* @ingroup API

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( 'ApiFormatBase.php' );
}
/**
* API YAML output formatter
* @ingroup API

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( 'ApiBase.php' );
}
/**
* This is a simple class to handle action=help
*

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( 'ApiBase.php' );
}
/**
* API module that imports an XML file like Special:Import does
*

View file

@ -25,11 +25,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( 'ApiBase.php' );
}
/**
* Unit to authenticate log-in attempts to the current wiki.
*

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( 'ApiBase.php' );
}
/**
* API module to allow users to log out of the wiki. API equivalent of
* Special:Userlogout.

View file

@ -25,11 +25,6 @@
* @defgroup API API
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( 'ApiBase.php' );
}
/**
* This is the main API class, used for both external and internal processing.
* When executed, it will create the requested formatter object,

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( "ApiBase.php" );
}
/**
* API Module to move pages
* @ingroup API

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( "ApiBase.php" );
}
/**
* @ingroup API
*/

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( 'ApiQueryBase.php' );
}
/**
* This class contains a list of pages that the client has requested.
* Initially, when the client passes in titles=, pageids=, or revisions=

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( "ApiBase.php" );
}
/**
* @ingroup API
*/

View file

@ -22,11 +22,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( "ApiBase.php" );
}
/**
* @ingroup API
*/

View file

@ -24,10 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
require_once ( 'ApiBase.php' );
}
/**
* Allows user to patrol pages
* @ingroup API

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( "ApiBase.php" );
}
/**
* @ingroup API
*/

View file

@ -25,10 +25,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
require_once( 'ApiBase.php' );
}
/**
* API interface for page purging
* @ingroup API

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( 'ApiBase.php' );
}
/**
* This is the main query class. It behaves similar to ApiMain: based on the
* parameters given, it will create a list of titles to work on (an ApiPageSet

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( 'ApiQueryBase.php' );
}
/**
* Query module to enumerate all categories, even the ones that don't have
* category pages.

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( 'ApiQueryBase.php' );
}
/**
* Query module to enumerate links from all pages together.
*

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( 'ApiQueryBase.php' );
}
/**
* Query module to enumerate all registered users.
*

View file

@ -26,11 +26,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( 'ApiQueryBase.php' );
}
/**
* Query module to enumerate all available pages.
*

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( 'ApiQueryBase.php' );
}
/**
* A query action to return messages from site message cache
*

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( 'ApiQueryBase.php' );
}
/**
* Query module to enumerate all available pages.
*

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( "ApiQueryBase.php" );
}
/**
* This is a three-in-one module to query:
* * backlinks - links pointing to the given page,

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( 'ApiBase.php' );
}
/**
* This is a base class for all Query modules.
* It provides some common functionality such as constructing various SQL

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( 'ApiQueryBase.php' );
}
/**
* Query module to enumerate all user blocks
*

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( "ApiQueryBase.php" );
}
/**
* A query module to enumerate categories the set of pages belong to.
*

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( "ApiQueryBase.php" );
}
/**
* This query adds the <categories> subelement to all pages with the list of categories the page is in
*

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( "ApiQueryBase.php" );
}
/**
* A query module to enumerate pages that belong to a category.
*

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( 'ApiQueryBase.php' );
}
/**
* Query module to enumerate all deleted revisions.
*

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( "ApiBase.php" );
}
/**
* API module that does nothing
*

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( "ApiQueryBase.php" );
}
/**
* A query module to list duplicates of the given file(s)
*

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( 'ApiQueryBase.php' );
}
/**
* @ingroup API
*/

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( "ApiQueryBase.php" );
}
/**
* A query module to list all external URLs found on a given set of pages.
*

View file

@ -26,11 +26,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( 'ApiQueryBase.php' );
}
/**
* Query module to enumerate all deleted files.
*

View file

@ -25,11 +25,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( "ApiQueryBase.php" );
}
/**
* This gives links pointing to the given interwiki
* @ingroup API

View file

@ -25,11 +25,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( "ApiQueryBase.php" );
}
/**
* A query module to list all interwiki links on a page
*

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( 'ApiQueryBase.php' );
}
/**
* A query action to get image information and upload history.
*

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( "ApiQueryBase.php" );
}
/**
* This query adds an <images> subelement to all pages with the list of images embedded into those pages.
*

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( 'ApiQueryBase.php' );
}
/**
* A query module to show basic page information.
*

View file

@ -25,11 +25,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( "ApiQueryBase.php" );
}
/**
* This gives links pointing to the given interwiki
* @ingroup API

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( "ApiQueryBase.php" );
}
/**
* A query module to list all langlinks (links to correspanding foreign language pages).
*

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( "ApiQueryBase.php" );
}
/**
* A query module to list all wiki links on a given set of pages.
*

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( 'ApiQueryBase.php' );
}
/**
* Query action to List the log events, with optional filtering by various parameters.
*

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( 'ApiQueryBase.php' );
}
/**
* A query module to show basic page information.
*

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( 'ApiQueryBase.php' );
}
/**
* Query module to enumerate all create-protected pages.
*

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( 'ApiQueryBase.php' );
}
/**
* Query module to get the results of a QueryPage-based special page
*

View file

@ -25,11 +25,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( 'ApiQueryBase.php' );
}
/**
* Query module to get list of random pages
*

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( 'ApiQueryBase.php' );
}
/**
* A query action to enumerate the recent changes that were done to the wiki.
* Various filters are supported.

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( 'ApiQueryBase.php' );
}
/**
* A query action to enumerate revisions of a given page, or show top revisions of multiple pages.
* Various pieces of information may be shown - flags, comments, and the actual wiki markup of the rev.

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( 'ApiQueryBase.php' );
}
/**
* Query module to perform full text search within wiki titles and content
*

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( 'ApiQueryBase.php' );
}
/**
* A query action to return meta information about the wiki site.
*

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( 'ApiQueryBase.php' );
}
/**
* Query module to enumerate change tags.
*

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( 'ApiQueryBase.php' );
}
/**
* This query action adds a list of a specified user's contributions to the output.
*

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( 'ApiQueryBase.php' );
}
/**
* Query module to get information about the currently logged-in user
*

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( 'ApiQueryBase.php' );
}
/**
* Query module to get information about a list of users
*

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( 'ApiQueryBase.php' );
}
/**
* This query action allows clients to retrieve a list of recently modified pages
* that are part of the logged-in user's watchlist.

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( 'ApiQueryBase.php' );
}
/**
* This query action allows clients to retrieve a list of pages
* on the logged-in user's watchlist.

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( 'ApiBase.php' );
}
/**
* This class represents the result of the API operations.
* It simply wraps a nested array() structure, adding some functions to simplify array's modifications.

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( "ApiBase.php" );
}
/**
* @ingroup API
*/

View file

@ -25,10 +25,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
require_once( 'ApiBase.php' );
}
/**
* API module for sending out RSD information
* @ingroup API

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( "ApiBase.php" );
}
/**
* API module that facilitates the unblocking of users. Requires API write mode
* to be enabled.

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( "ApiBase.php" );
}
/**
* @ingroup API
*/

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( "ApiBase.php" );
}
/**
* @ingroup API
*/

View file

@ -25,11 +25,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( "ApiBase.php" );
}
/**
* @ingroup API
*/

View file

@ -24,11 +24,6 @@
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( 'ApiBase.php' );
}
/**
* API module to allow users to watch a page
*