From: Timo Tijhof <krinklemail@gmail.com>
Date: Mon, 8 Jul 2019 20:24:45 +0000 (+0100)
Subject: entrypoint: Avoid random Doxygen block from api.php and opensearch_desc.php
X-Git-Tag: 1.34.0-rc.0~1133^2
X-Git-Url: https://git.cyclocoop.org/%27.WWW_URL.%27admin/?a=commitdiff_plain;h=da31eba45fecfced50d261f00793b2492c7032b5;p=lhc%2Fweb%2Fwiklou.git

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

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
---

diff --git a/api.php b/api.php
index db9de75156..0fb674b9eb 100644
--- a/api.php
+++ b/api.php
@@ -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
diff --git a/opensearch_desc.php b/opensearch_desc.php
index 15ec62d0e5..b546cbf6e8 100644
--- a/opensearch_desc.php
+++ b/opensearch_desc.php
@@ -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 );