Fix doxygen return class with namespace
authorFlorianschmidtwelzow <florian.schmidt.welzow@t-online.de>
Thu, 23 Jul 2015 05:42:41 +0000 (07:42 +0200)
committerFlorianschmidtwelzow <florian.schmidt.welzow@t-online.de>
Thu, 23 Jul 2015 05:42:41 +0000 (07:42 +0200)
Doxygen uses a single "\" as a start sign for a command.
Anything after "OOUI" will be interpreted as a command
(and throws a warning "Unknown command" or something else) when
you create the doc. The doc itself will show the following
as the return values of the function:
Returns
    OOUI|OOUI

See: https://phabricator.wikimedia.org/F214499

As a workaround you can escape the backslash with a second
backslash (OOUI\\FieldLayout) or this notation should work, too:
OOUI::Fieldlayout

Follow up: I9050c4a09cbb841ad26ca01a25f706227e35e3be

Change-Id: I0c9300e72e00e1d827c63074cbaa51a935828695

includes/htmlform/HTMLFormField.php

index 1d9b255..1d8137e 100644 (file)
@@ -604,7 +604,7 @@ abstract class HTMLFormField {
 
        /**
         * Get a FieldLayout (or subclass thereof) to wrap this field in when using OOUI output.
-        * @return OOUI\FieldLayout|OOUI\ActionFieldLayout
+        * @return OOUI\\FieldLayout|OOUI\\ActionFieldLayout
         */
        protected function getFieldLayoutOOUI( $inputField, $config ) {
                if ( isset( $this->mClassWithButton ) ) {