More doc comment fiddling
authorBrion Vibber <brion@users.mediawiki.org>
Thu, 28 Oct 2004 06:05:22 +0000 (06:05 +0000)
committerBrion Vibber <brion@users.mediawiki.org>
Thu, 28 Oct 2004 06:05:22 +0000 (06:05 +0000)
includes/DifferenceEngine.php
includes/ParserXML.php
includes/Skin.php
includes/SkinPHPTal.php
maintenance/mwdocgen.php

index 09c9a80..b217a00 100644 (file)
@@ -2,11 +2,12 @@
 /**
  * See diff.doc
  * @package MediaWiki 
+ * @subpackage DifferenceEngine
  */
 
 /**
  * @todo document
- * @package MediaWiki
+ * @access public
  */
 class DifferenceEngine {
        /* private */ var $mOldid, $mNewid;
@@ -335,7 +336,7 @@ define('USE_ASSERTS', function_exists('assert'));
 
 /**
  * @todo document
- * @package MediaWiki
+ * @access private
  */
 class _DiffOp {
        var $type;
@@ -357,7 +358,7 @@ class _DiffOp {
 
 /**
  * @todo document
- * @package MediaWiki
+ * @access private
  */
 class _DiffOp_Copy extends _DiffOp {
        var $type = 'copy';
@@ -376,7 +377,7 @@ class _DiffOp_Copy extends _DiffOp {
 
 /**
  * @todo document
- * @package MediaWiki
+ * @access private
  */
 class _DiffOp_Delete extends _DiffOp {
        var $type = 'delete';
@@ -393,7 +394,7 @@ class _DiffOp_Delete extends _DiffOp {
 
 /**
  * @todo document
- * @package MediaWiki
+ * @access private
  */
 class _DiffOp_Add extends _DiffOp {
        var $type = 'add';
@@ -410,7 +411,7 @@ class _DiffOp_Add extends _DiffOp {
 
 /**
  * @todo document
- * @package MediaWiki
+ * @access private
  */
 class _DiffOp_Change extends _DiffOp {
        var $type = 'change';
@@ -444,7 +445,6 @@ class _DiffOp_Change extends _DiffOp {
  * are my own.
  *
  * @author Geoffrey T. Dairiki
- * @package MediaWiki
  * @access private
  */
 class _DiffEngine
@@ -831,7 +831,7 @@ class _DiffEngine
 /**
  * Class representing a 'diff' between two sequences of strings.
  * @todo document
- * @package MediaWiki
+ * @access private
  */
 class Diff
 {
@@ -968,7 +968,7 @@ class Diff
 /**
  * FIXME: bad name.
  * @todo document
- * @package MediaWiki
+ * @access private
  */
 class MappedDiff extends Diff
 {
@@ -1027,7 +1027,7 @@ class MappedDiff extends Diff
  * It is intended that this class be customized via inheritance,
  * to obtain fancier outputs.
  * @todo document
- * @package MediaWiki
+ * @access private
  */
 class DiffFormatter
 {
@@ -1185,7 +1185,7 @@ define('NBSP', '&#160;');                 // iso-8859-x non-breaking space.
 
 /**
  * @todo document
- * @package MediaWiki
+ * @access private
  */
 class _HWLDF_WordAccumulator {
        function _HWLDF_WordAccumulator () {
@@ -1242,7 +1242,7 @@ class _HWLDF_WordAccumulator {
 
 /**
  * @todo document
- * @package MediaWiki
+ * @access private
  */
 class WordLevelDiff extends MappedDiff
 {
@@ -1292,7 +1292,7 @@ class WordLevelDiff extends MappedDiff
 /**
  *     Wikipedia Table style diff formatter.
  * @todo document
- * @package MediaWiki
+ * @access private
  */
 class TableDiffFormatter extends DiffFormatter
 {
index e2f1770..059e271 100644 (file)
@@ -3,11 +3,11 @@
  * This should one day become the XML->(X)HTML parser
  * Based on work by Jan Hidders and Magnus Manske
  * @package MediaWiki
+ * @subpackage Experimental
  */
 
 /**
  * the base class for an element
- * @package MediaWiki
  */
 class element {
     var $name = '';
@@ -72,8 +72,6 @@ function wgXMLcharacterData($parser, $data) {
 
 /**
  * Here's the class that generates a nice tree
- * package parserxml
- * @package MediaWiki
  */
 class xml2php {
 
index 3db1043..ad76845 100644 (file)
@@ -3,6 +3,7 @@
 /**
  *
  * @package MediaWiki
+ * @subpackage Skins
  */
 
 /**
index 9a68314..82f2dbd 100644 (file)
@@ -28,6 +28,7 @@
  * $wgUsePHPTal = true;
  *
  * @package MediaWiki
+ * @subpackage Skins
  */
 
 /**
index 3702cd8..ba95e9f 100755 (executable)
@@ -39,9 +39,8 @@ $here = dirname( dirname( __FILE__ ) ) . $sep;
 $pdOutput = "{$here}{$sep}docs{$sep}html";
 
 /** Some more Phpdoc settings */
-$pdOthers = '';
-//$pdOthers = ' -dn \'MediaWiki\' ';
-$pdOthers .= ' --title \'MediaWiki generated documentation\' -o \'HTML:frames:DOM/earthli\' --ignore AdminSettings.php,LocalSettings.php --parseprivate on ';
+$pdOthers = ' -dn \'MediaWiki\' ';
+$pdOthers .= ' --title \'MediaWiki generated documentation\' -o \'HTML:frames:DOM/earthli\' --ignore AdminSettings.php,LocalSettings.php,tests/LocalTestSettings.php --parseprivate on ';
 
 /** MediaWiki location */
 #$mwPath = '/var/www/mediawiki/';