Thijs/wiki.techinc.nl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

entrypoint: Avoid random Doxygen block from api.php and opensearch_desc.php

Browse source 
These two entry points have themselves partly indexed by Doxygen
in a very strange way where these two comments cause part of an
if-statement to be seen as the name of a local variable.
Probably due to some kind of bad interaction with the
maintenance/mwdoc-filter.php filter applied to the file before
it gets indexed.

Fix it for now by avoiding use of /** blocks for something that
isn't a class, function, class member or documented global var.

Change-Id: I4903069e704c3283e6ec7a39999a489d0117cc71
This commit is contained in:
Timo Tijhof 2019-07-08 21:24:45 +01:00
parent 9c36c584ff
commit da31eba45f
2 changed files with 13 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
api.php
View file

@ -61,10 +61,9 @@ $wgTitle = Title::makeTitle( NS_SPECIAL, 'Badtitle/dummy title for API calls set
RequestContext::getMain()->setTitle( $wgTitle );
try {
/* Construct an ApiMain with the arguments passed via the URL. What we get back
* is some form of an ApiMain, possibly even one that produces an error message,
* but we don't care here, as that is handled by the constructor.
*/
// Construct an ApiMain with the arguments passed via the URL. What we get back
// is some form of an ApiMain, possibly even one that produces an error message,
// but we don't care here, as that is handled by the constructor.
$processor = new ApiMain( RequestContext::getMain(), true );
// Last chance hook before executing the API

21
opensearch_desc.php
View file

@ -48,17 +48,16 @@ print Xml::openElement( 'OpenSearchDescription',
'xmlns' => 'http://a9.com/-/spec/opensearch/1.1/',
'xmlns:moz' => 'http://www.mozilla.org/2006/browser/search/' ] );
/* The spec says the ShortName must be no longer than 16 characters,
* but 16 is *realllly* short. In practice, browsers don't appear to care
* when we give them a longer string, so we're no longer attempting to trim.
*
* Note: ShortName and the <link title=""> need to match; they are used as
* a key for identifying if the search engine has been added already, *and*
* as the display name presented to the end-user.
*
* Behavior seems about the same between Firefox and IE 7/8 here.
* 'Description' doesn't appear to be used by either.
*/
// The spec says the ShortName must be no longer than 16 characters,
// but 16 is *realllly* short. In practice, browsers don't appear to care
// when we give them a longer string, so we're no longer attempting to trim.
//
// Note: ShortName and the <link title=""> need to match; they are used as
// a key for identifying if the search engine has been added already, *and*
// as the display name presented to the end-user.
//
// Behavior seems about the same between Firefox and IE 7/8 here.
// 'Description' doesn't appear to be used by either.
$fullName = wfMessage( 'opensearch-desc' )->inContentLanguage()->text();
print Xml::element( 'ShortName', null, $fullName );
print Xml::element( 'Description', null, $fullName );