API: Fix doc comment for ApiFormatNone

[lhc/web/wiklou.git] / includes / linker / LinkTarget.php

diff --git a/includes/linker/LinkTarget.php b/includes/linker/LinkTarget.php
index 7b59751..980a8bf 100644 (file)
--- a/includes/linker/LinkTarget.php
+++ b/includes/linker/LinkTarget.php
@@ -28,13 +28,24 @@ interface LinkTarget {
 
        /**
         * Get the namespace index.
+        * @since 1.27
         *
         * @return int Namespace index
         */
        public function getNamespace();
 
+       /**
+        * Convenience function to test if it is in the namespace
+        * @since 1.27
+        *
+        * @param int $ns
+        * @return bool
+        */
+       public function inNamespace( $ns );
+
        /**
         * Get the link fragment (i.e. the bit after the #) in text form.
+        * @since 1.27
         *
         * @return string link fragment
         */
@@ -42,6 +53,7 @@ interface LinkTarget {
 
        /**
         * Whether the link target has a fragment
+        * @since 1.27
         *
         * @return bool
         */
@@ -49,6 +61,7 @@ interface LinkTarget {
 
        /**
         * Get the main part with underscores.
+        * @since 1.27
         *
         * @return string Main part of the link, with underscores (for use in href attributes)
         */
@@ -56,8 +69,8 @@ interface LinkTarget {
 
        /**
         * Returns the link in text form, without namespace prefix or fragment.
-        *
         * This is computed from the DB key by replacing any underscores with spaces.
+        * @since 1.27
         *
         * @return string
         */
@@ -67,6 +80,7 @@ interface LinkTarget {
         * Creates a new LinkTarget for a different fragment of the same page.
         * It is expected that the same type of object will be returned, but the
         * only requirement is that it is a LinkTarget.
+        * @since 1.27
         *
         * @param string $fragment The fragment name, or "" for the entire page.
         *
@@ -76,6 +90,7 @@ interface LinkTarget {
 
        /**
         * Whether this LinkTarget has an interwiki component
+        * @since 1.27
         *
         * @return bool
         */
@@ -83,8 +98,20 @@ interface LinkTarget {
 
        /**
         * The interwiki component of this LinkTarget
+        * @since 1.27
         *
         * @return string
         */
        public function getInterwiki();
+
+       /**
+        * Returns an informative human readable representation of the link target,
+        * for use in logging and debugging. There is no requirement for the return
+        * value to have any relationship with the input of TitleParser.
+        * @since 1.31
+        *
+        * @return string
+        */
+       public function __toString();
+
 }