* @link. You might think @link would surely mean "here comes a web URL" ... but @link is a valid command
in Doxygen, which means an entirely different kind of link (an internal link to somewhere, so that you can separate
documentation and implementation). The result is a mess, and the best solution I can see is to use "@see" instead of "@link".
* Warning: argument `nourl' of command @param is not found in the argument list of Linker::makeMediaLinkObj($title,$text='')
* Moving few class descriptions to right above classes, and/or formatting into Javadoc style.
* "@addtogroup Special Pages" --> "@addtogroup SpecialPage" so that all special pages have the same @addtogroup tag.
* @fixme --> @todo (must have missed these before)
* "@param $specialPage @see" remove the "@" in the "@see" to stop warning.
* @throws wants type, then a brief description, to stop warning.
This last one is for PHPdocumentor only, but it fixes something for PHPDocumentor, and should be neutral for Doxygen:
* WARNING in includes/api/ApiFormatYaml_spyc.php on line 860: docblock template never terminated with /**#@-*/
* the PHP memcached client.
*
* backends for local hash array and SQL table included:
- * $bag = new HashBagOStuff();
- * $bag = new MysqlBagOStuff($tablename); # connect to db first
+ * <code>
+ * $bag = new HashBagOStuff();
+ * $bag = new MysqlBagOStuff($tablename); # connect to db first
+ * </code>
*
*/
class BagOStuff {
* articles are in one or all of a given subset of categories.
*
* Example use :
- *
- * # Determines wether the article with the page_id 12345 is in both
+ * <code>
+ * # Determines whether the article with the page_id 12345 is in both
* # "Category 1" and "Category 2" or their subcategories, respectively
*
* $cf = new Categoryfinder ;
* ) ;
* $a = $cf->run() ;
* print implode ( "," , $a ) ;
- *
+ * </code>
*
*/
class Categoryfinder {
/**
* Constructor (currently empty).
- */
+ */
function __construct() {
}
/**
* Iterates through the parent tree starting with the seed values,
* then checks the articles if they match the conditions
- @return array of page_ids (those given to seed() that match the conditions)
- */
+ * @return array of page_ids (those given to seed() that match the conditions)
+ */
function run () {
$this->dbr = wfGetDB( DB_SLAVE );
while ( count ( $this->next ) > 0 ) {
/**
* This functions recurses through the parent representation, trying to match the conditions
- @param $id The article/category to check
- @param $conds The array of categories to match
- @return bool Does this match the conditions?
- */
+ * @param $id The article/category to check
+ * @param $conds The array of categories to match
+ * @return bool Does this match the conditions?
+ */
function check ( $id , &$conds ) {
# Shortcut (runtime paranoia): No contitions=all matched
if ( count ( $conds ) == 0 ) return true ;
/**
* Scans a "parent layer" of the articles/categories in $this->next
- */
+ */
function scan_next_layer () {
$fname = "Categoryfinder::scan_next_layer" ;
}
public function setTimeout( $timeout ) {
- /// @fixme no-op
+ // @todo no-op
}
function ping() {
}
public function setTimeout( $timeout ) {
- /// @fixme no-op
+ // @todo no-op
}
function ping() {
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
- * @link http://exif.org/Exif2-2.PDF The Exif 2.2 specification
+ * @see http://exif.org/Exif2-2.PDF The Exif 2.2 specification
*/
/**
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
# http://www.gnu.org/copyleft/gpl.html
+
/**
*
* @addtogroup SpecialPage
*/
-
class WikiExporter {
var $list_authors = false ; # Return distinct author list (when not returning full history)
var $author_list = "" ;
* Note that some PHP configuration options may add output buffer
* layers which cannot be removed; these are left in place.
*
- * @parameter bool $resetGzipEncoding
+ * @param bool $resetGzipEncoding
*/
function wfResetOutputBuffers( $resetGzipEncoding=true ) {
if( $resetGzipEncoding ) {
/**
* An Exif timestamp (YYYY:MM:DD HH:MM:SS)
*
- * @link http://exif.org/Exif2-2.PDF The Exif 2.2 spec, see page 28 for the
+ * @see http://exif.org/Exif2-2.PDF The Exif 2.2 spec, see page 28 for the
* DateTime tag and page 36 for the DateTimeOriginal and
* DateTimeDigitized tags.
*/
* Split out an IP block as an array of 4 bytes and a mask,
* return false if it can't be determined
*
- * @parameter $ip string A quad dotted/octet IP address
+ * @param $ip string A quad dotted/octet IP address
* @return array
*/
public static function toArray( $ipblock ) {
}
$dbw->insert( $table, $fields, __METHOD__ );
- /// @fixme this delete is not totally safe, potentially
+ // @todo this delete is not totally safe, potentially
$dbw->delete( 'filearchive',
array( 'fa_id' => $row->fa_id ),
__METHOD__ );
*
* @param $title Title object.
* @param $text String: pre-sanitized HTML
- * @param $nourl Boolean: Mask absolute URLs, so the parser doesn't
- * linkify them (it is currently not context-aware)
* @return string HTML
*
* @public
* Since you can't set a default parameter for a reference, I've turned it
* temporarily to a value pass. Should be adjusted further. --brion
*
- * $param string $comment
+ * @param string $comment
* @param mixed $title Title object (to generate link to the section in autocomment) or null
* @param bool $local Whether section links should refer to local page
*/
* Given a value escape it so that it can be used in an id attribute and
* return it, this does not validate the value however (see first link)
*
- * @link http://www.w3.org/TR/html401/types.html#type-name Valid characters
+ * @see http://www.w3.org/TR/html401/types.html#type-name Valid characters
* in the id and
* name attributes
- * @link http://www.w3.org/TR/html401/struct/links.html#h-12.2.3 Anchors with the id attribute
+ * @see http://www.w3.org/TR/html401/struct/links.html#h-12.2.3 Anchors with the id attribute
*
* @static
*
*
* @todo For extra validity, input should be validated UTF-8.
*
- * @link http://www.w3.org/TR/CSS21/syndata.html Valid characters/format
+ * @see http://www.w3.org/TR/CSS21/syndata.html Valid characters/format
*
* @param string $class
* @return string
/**
* Entry point : initialise variables and call subfunctions.
* @param $par String: becomes "FOO" when called like Special:Allpages/FOO (default NULL)
- * @param $specialPage @see SpecialPage object.
+ * @param $specialPage See the SpecialPage object.
*/
function wfSpecialAllpages( $par=NULL, $specialPage ) {
global $wgRequest, $wgOut, $wgContLang;
* Special page outputs information on sourcing a book with a particular ISBN
* The parser creates links to this page when dealing with ISBNs in wikitext
*
- * @addtogroup Special pages
+ * @addtogroup SpecialPage
* @author Rob Church <robchur@gmail.com>
* @todo Validate ISBNs using the standard check-digit method
*/
* Special page allows users to request email confirmation message, and handles
* processing of the confirmation code when the link in the email is followed
*
- * @addtogroup Special pages
+ * @addtogroup SpecialPage
* @author Rob Church <robchur@gmail.com>
*/
/**
* Generates the subheading with links
- * @param $nt @see Title object for the target
+ * @param $nt see the Title object for the target
*/
function contributionsSub( $nt ) {
global $wgSysopUserBans, $wgUser;
/**
* Special page to direct the user to a random redirect page (minus the second redirect)
*
- * @addtogroup Special pages
+ * @addtogroup SpecialPage
* @author Rob Church <robchur@gmail.com>
* @license GNU General Public Licence 2.0 or later
*/
/**
* Makes change an option link which carries all the other options
- * @param $title @see Title
+ * @param $title see Title
* @param $override
* @param $options
*/
}
/**
- * @throws PasswordError
+ * @throws PasswordError when cannot set the new password because requirements not met.
*/
function attemptReset( $newpass, $retype ) {
$user = User::newFromName( $this->mName );
/**
* Special page lists images which haven't been categorised
*
- * @addtogroup Special pages
+ * @addtogroup SpecialPage
* @author Rob Church <robchur@gmail.com>
*/
* Special page allowing users with the appropriate permissions to view
* and restore deleted content
*
- * @addtogroup Special pages
+ * @addtogroup SpecialPage
*/
/**
<?php
/**
- * @addtogroup Special pages
- *
* @author Rob Church <robchur@gmail.com>
* @copyright © 2006 Rob Church
* @license http://www.gnu.org/copyleft/gpl.html GNU General Public License 2.0 or later
- */
-
-/**
* @addtogroup SpecialPage
*/
-
class UnusedtemplatesPage extends QueryPage {
function getName() { return( 'Unusedtemplates' ); }
/**
* Constructor
- * @param webrequest $request A webrequest object passed by reference
+ * @param WebRequest $request A WebRequest object passed by reference
*/
function LoginForm( &$request ) {
global $wgLang, $wgAllowRealName, $wgEnableEmail;
/**
* Special page to allow managing user group membership
*
- * @addtogroup Special pages
+ * @addtogroup SpecialPage
* @todo This code is disgusting and needs a total rewrite
*/
* USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
* DAMAGE.
*
-* @category
* @addtogroup Services_JSON
* @author Michal Migurski <mike-json@teczno.com>
* @author Matt Knapp <mdknapp[at]gmail[dot]com>
* @copyright 2005 Michal Migurski
* @version CVS: $Id: JSON.php,v 1.30 2006/03/08 16:10:20 migurski Exp $
* @license http://www.opensource.org/licenses/bsd-license.php
-* @link http://pear.php.net/pepr/pepr-proposal-show.php?id=198
+* @see http://pear.php.net/pepr/pepr-proposal-show.php?id=198
*/
/**
* Spyc -- A Simple PHP YAML Class
* @version 0.2.3 -- 2006-02-04
* @author Chris Wanstrath <chris@ozmm.org>
- * @link http://spyc.sourceforge.net/
+ * @see http://spyc.sourceforge.net/
* @copyright Copyright 2005-2006 Chris Wanstrath
* @license http://www.opensource.org/licenses/mit-license.php MIT License
* @addtogroup Spyc
*/
var $parent;
var $id;
- /**#@+*/
+ /**#@-*/
/**
* @access public
* @var mixed
var $_isInline;
var $_dumpIndent;
var $_dumpWordWrap;
- /**#@+*/
+ /**#@-*/
/**** Private Methods ****/
return $ret;
}
}
-?>
\ No newline at end of file
+?>
}
/**
-* @desc This exception will be thrown when dieUsage is called to stop module execution.
-*/
+ * This exception will be thrown when dieUsage is called to stop module execution.
+ */
class UsageException extends Exception {
private $mCodestr;
dépôts / lhc / web / wiklou.git / commitdiff