* Returns the normalized form of the given page title, using the
* normalization rules of the given site. If the given title is a redirect,
* the redirect will be resolved and the redirect target is returned.
+ * Only titles of existing pages will be returned.
*
* @note This actually makes an API request to the remote site, so beware
* that this function is slow and depends on an external service.
* @param string $pageName
* @param string $apiUrl
*
- * @return string|false
+ * @return string|false The normalized form of the title,
+ * or false to indicate an invalid title, a missing page,
+ * or some other kind of error.
* @throws \MWException
*/
public function normalizePageName( $pageName, $apiUrl ) {
* Returns the normalized form of the given page title, using the
* normalization rules of the given site. If the given title is a redirect,
* the redirect will be resolved and the redirect target is returned.
+ * Only titles of existing pages will be returned.
*
* @note This actually makes an API request to the remote site, so beware
* that this function is slow and depends on an external service.
*
* @param string $pageName
*
- * @return string|false
+ * @return string|false The normalized form of the title,
+ * or false to indicate an invalid title, a missing page,
+ * or some other kind of error.
* @throws MWException
*/
public function normalizePageName( $pageName ) {
}
/**
- * Returns $pageName without changes.
- * Subclasses may override this to apply some kind of normalization.
+ * Attempt to normalize the page name in some fashion.
+ * May return false to indicate various kinds of failure.
+ *
+ * This implementation returns $pageName without changes.
*
* @see Site::normalizePageName
*