Commit graph

77 commits

Author SHA1 Message Date
Antoine Musso
1a9246e1b8 ChannelFeed now marked as an abstract class
The ChannelFeed class has always been considered as an abstract class.
Looks like we forgot to update its definition since PHP switched to
support class abstractions.

Also marked abstract the three inner methods that must be extended:

 ChannelFeed::outHeader()
 ChannelFeed::outItem()
 ChannelFeed::outFooter()

Change-Id: Ie0111786af37531d53ee3fc845e0125136ca298f
2012-07-10 17:06:59 +01:00
Antoine Musso
f3f985c619 remove unneeded @abstract
Doxygen does recognize abstract methods when it is properly marked as
abstracted. That keyword is a left.

Change-Id: I7df790058edf0eefb07eb4c37a2586b5c16898e3
2012-07-10 16:43:05 +01:00
Sam Reed
76246b9bf5 More return documentation 2012-02-09 21:33:27 +00:00
Sam Reed
ec4604de3d Documentation and whitespace
Clearing another w/c
2012-01-19 14:56:18 +00:00
Alexandre Emsenhuber
eefe59bc4d Per Nikerabbit, fix undefined variable notice from r102851 2011-11-12 12:13:08 +00:00
Alexandre Emsenhuber
e35e645a1b * Renamed member variables to begin with a lower case
* Moved constant definitions from the constructor to the class definition
* Removed default values from the class definition for members that are always set in the constructor
2011-11-12 09:57:47 +00:00
Alexandre Emsenhuber
7c77b828b6 Removed FeedItem::getLastMod() and FeedItem::getDBPrefixedTitle() since they are not used and would throw an error since FeedItem::$Title is a string and not an object 2011-11-10 12:09:33 +00:00
Roan Kattouw
403f87be35 Rename $wgVaryOnXFPForAPI (introduced in r93818) to $wgVaryOnXFP and extend it to also apply to HTTP redirects. The previous name was overly specific for what has become a more generic setting, and we can still change it now that it's not in any release yet. 2011-10-03 13:15:28 +00:00
Roan Kattouw
75681bc57a Expand some more URLs: for feeds, referers and the proxy script 2011-08-19 17:31:40 +00:00
Roan Kattouw
b154959876 Make $wgVaryOnXFPForAPI apply to RSS/Atom feeds too, because they too use PROT_CURRENT. Make PROT_CURRENT usage explicit there too 2011-08-19 14:41:35 +00:00
Sam Reed
50d5b074d0 And some more parameter documentation!! 2011-05-28 16:31:00 +00:00
Siebrand Mazeland
75c6696aa8 Use consistent notation for "@todo FIXME". Should update http://svn.wikimedia.org/doc/todo.html nicely. 2011-05-17 22:03:20 +00:00
Tim Starling
6fec4e3fde Revert r87635, r87637, r87639, r87643 (MW_MIN_PHP_VERSION etc.): breaks HipHop support. 2011-05-15 13:21:16 +00:00
Happy-melon
fd34d0354b * Implement MW_VERSION constant in Defines.php and use it in preference to $wgVersion. Defines.php will have been loaded anywhere that DefaultSettings.php has been loaded.
* Move the declaration of $wgFeedClasses from Defines.php to WebStart.php
2011-05-07 14:53:08 +00:00
Niklas Laxström
9b93f1635b Fix more botched something in r86457 2011-04-20 08:44:54 +00:00
Niklas Laxström
99b02fc756 Fix botched something in r86457 2011-04-20 08:38:47 +00:00
Mark A. Hershberger
45c87acdd0 Revert r86455 based on bawolff's comments 2011-04-20 04:28:20 +00:00
Mark A. Hershberger
57919f0bbd DOH, cut-n-paste error. 2011-04-20 04:08:37 +00:00
Mark A. Hershberger
aadcbd3957 Refactor need for duplicate private Title in FeedSMItem away by moving functionality to parent. 2011-04-20 03:58:34 +00:00
Sam Reed
ea056f5171 Fixup a few undefined variables and alike while checking REL1_17 2011-04-04 21:13:34 +00:00
Niklas Laxström
665ed62453 Spell false with small latter 2011-01-11 14:28:35 +00:00
Platonides
c7e95055fa The default value of isPermaLink is true, not including it does nothing.
http://www.rssboard.org/rss-specification#ltguidgtSubelementOfLtitemgt
2010-11-16 17:44:08 +00:00
Platonides
537826a674 Remove $wgContLanguageCode usage in core.
sed -i 's/$wgContLanguageCode/$wgLanguageCode/g'
These are now the same, always. Per and since r15827.

$wgLanguageCode wins due to being the one set by LocalSettings.

$wgContLanguageCode definition at includes/Setup.php kept for now.
2010-09-07 22:37:55 +00:00
Alexandre Emsenhuber
7b79d94515 * Standardised file description headers
* Added some descriptions
* Added @file where needed
2010-08-14 17:42:40 +00:00
Aryeh Gregor
11284695f1 Add <guid> to RSS to avoid duplicates
Bug 7346.  Patch by Jools Wills (buzz).
2010-01-15 18:00:56 +00:00
Alexandre Emsenhuber
36d2910fa9 * Document a bit
* Add new doxygen group "Feed"
* Fix some doxygen warnings
2010-01-09 21:59:40 +00:00
Aaron Schulz
cc554b1230 Add FeedItem::stripComment() and remove duplication 2008-11-19 00:11:14 +00:00
Roan Kattouw
6a2f8c1193 * (bug 15497) Removed encoding attribute from <?xml ?> tags 2008-09-10 13:39:24 +00:00
Aryeh Gregor
46727906bb (bug 15128) Documentation for xmlEncode is wrong, it's not static. 2008-08-13 01:53:03 +00:00
Brion Vibber
3937270fb1 Revert r39198 "* (bug 15128) Feed:xmlEncode() function now declared as static"
FeedItem::xmlEncode() is only called *non*-statically
2008-08-12 20:13:45 +00:00
Ryan Schmidt
d7139c4f35 * (bug 15128) Feed:xmlEncode() function now declared as static 2008-08-12 01:47:05 +00:00
Siebrand Mazeland
79d5225c0e * remove end of line whitespace
* remove empty lines at end of file
* remove "?>" where still present
2008-04-14 07:45:50 +00:00
Brion Vibber
8e476b31cc * (bug 12935, 12981) Fully-qualify archive URLs in delete, revert messages
Replaced a bunch of instances of 'if-this-is-not-fully-qualified-prepend-$wgServer' with a function, wfExpandUrl()
2008-02-13 05:59:14 +00:00
Brion Vibber
9c81db38d0 * (bug 5262) Fully-qualified $wgStylePath no longer corrupted on XML feeds 2008-02-12 22:34:43 +00:00
Aryeh Gregor
c8136cd6a2 Feeds for recent changes now provide URLs for the change (i.e., the diff), not just the page. This matches behavior of history feeds, which appears more correct. Incidentally, this code needs centralization, probably, say into a constructor method of Revision or Article. Logic is unnecessarily duplicated at present. (Also tweaked some docs, used __METHOD__ instead of $fname.) 2007-11-18 02:33:30 +00:00
Nick Jenkins
bd23ec29c6 Doc tweaks:
* Seems like an opportune time to introduce "@addtogroup Media" documentation tags.
* Merge "@addtogroup Metadata" (used by Exif.php) into "@addtogroup Media".
* Few more moving comment blocks to above classes.
2007-04-24 06:53:31 +00:00
Nick Jenkins
113bb1c772 Documentation tweaks to help documentation systems (Doxygen + PHPDocumentor)
pick up the appropriate tags, and documentation blobs for classes. This is 
the same as per r20769, but with the grouping changes (e.g. removing "@{{") omitted.
Please be advised that more related documentation tweaks may follow later - e.g. 
Doxygen generates a log file of warnings that is 574 Kb in size, when run over 
the just the trunk/phase3 code ... eek! Thankfully, much of that is just 
whining about functions without documentation   ;-)
2007-04-04 05:22:37 +00:00
Brion Vibber
3a6ac5a3c3 Revert r20769: we don't use PHPDocumentor anymore, we use doxygen.
If making mass changes to tweak to its preferences, probably better to do it for the tool we actually generate docs with. :)
2007-03-28 14:16:43 +00:00
Nick Jenkins
5fef2333d4 PHPDocumentor [http://en.wikipedia.org/wiki/PhpDocumentor] documentation tweaking stuff.
Minor doc tweaks to prevent some PHPDocumentor warnings or errors when run on the includes/ directory. PHPDocumentor uses a syntax very similar to javadoc - mostly we already use this, but there were a few scattered places that were adjusted to make them consistent with the rest of the code. In practical terms, these changes were made:
* @url becomes @link
* @fixme becomes @todo
* HTML tags in descriptions must be closed / balanced.
* @bug was removed (where the bug was long fixed), or changed into a @todo (in the few situations where the bug was still pending)
* @obsolete becomes @deprecated
* Things like "/**@{{" and "/**@}}*/" which cause "unknown tag" warnings were removed
* @access must be a valid access level.
* @desc tag not needed, removed.
* Doesn't seem to like @licence, will accept @license however.
* Use full comment block notation in a few places (i.e. open block with "/**", start each line with " *", and end block with " */")

Then additional to this, to get some class docs associated with their respective classes:
* Moved some docs to right above those classes (deleting blank lines, or moving descriptions from the file headers)
* Marked some classes without docs as "@todo document"
* (done up to "class MIMEsearchPage" on the "classtrees_MediaWiki.html" page for the includes/ directory)
2007-03-28 08:53:02 +00:00
Antoine Musso
c771fc9c96 Use Doxygen @addtogroup instead of phpdoc @package && @subpackage 2007-01-20 15:09:52 +00:00
Antoine Musso
b144fcb85d Rename constructors to __constructor 2007-01-20 13:34:31 +00:00
Brion Vibber
3af8ce82b9 * Added global $wgStyleVersion to centralize bumping CSS and JS file versions
for cache-friendly style and script updating
2006-10-13 21:48:19 +00:00
Antoine Musso
7ebdb6de89 Revert to r14165 . Did too many changes, didnt even run parserTests (i am bad) 2006-05-11 22:40:38 +00:00
Antoine Musso
3d4ea7c485 public / private / static stuff when loading Special:Recentchanges 2006-05-11 19:46:58 +00:00
Antoine Musso
69689725c1 Switching from phpdoc to doxygen (use less than 32MB of memory).
Run maintenance/mwdocgen.php to generate doc in ./docs/html/ .
2006-04-19 15:46:24 +00:00
Brion Vibber
f2c29baf9f Update the FSF's address in all these GPL stub headers 2006-04-05 07:43:17 +00:00
Lupin
11337038b3 removing unused globals and some whitespace cleaning 2006-03-07 01:10:39 +00:00
Ævar Arnfjörð Bjarmason
a26d5a49d7 * s~\t+$~~ 2006-01-07 13:31:29 +00:00
Ævar Arnfjörð Bjarmason
7bbe971aec * s~ +$~~ 2006-01-07 13:09:30 +00:00
Brion Vibber
1723dee5ae * (bug 3999) Change atom 1.0 feed id; had been unnecessarily complex due to
unclear language in the spec. Now using the URL, same as the permalink,
  which someone else will probably whine about because it's not 'perma'
  enough or something.
2005-11-17 00:17:30 +00:00