Merge pull request #13180 from mauriciofauth/fix/coding-standard

Fix some coding standard errors in DocBlocks

examples/openid.php

@@ -63,6 +63,13 @@ function Show_page($contents)
     <?php
 }
 
+/**
+ * Display error and exit
+ *
+ * @param Exception $e Exception object
+ *
+ * @return void
+ */
 function Die_error($e)
 {
     $contents = "<div class='relyingparty_results'>\n";

libraries/plugins/export/PMA_ExportPdf.php

@@ -86,6 +86,7 @@ class PMA_ExportPdf extends PDF
      *
      * @return void
      */
+    // @codingStandardsIgnoreLine
     public function Header()
     {
         global $maxY;

libraries/plugins/schema/pdf/Pdf.php

@@ -228,6 +228,7 @@ class Pdf extends PDF_lib
      *
      * @see TCPDF::Header()
      */
+    // @codingStandardsIgnoreLine
     public function Header()
     {
         // We only show this if we find something in the new pdf_pages table
@@ -261,6 +262,7 @@ class Pdf extends PDF_lib
      *
      * @see PDF::Footer()
      */
+    // @codingStandardsIgnoreLine
     public function Footer()
     {
         if ($this->_withDoc) {

libraries/twig/I18nExtension.php

@@ -18,7 +18,9 @@ use Twig_SimpleFilter;
 class I18nExtension extends Twig_Extensions_Extension_I18n
 {
     /**
-     * {@inheritdoc}
+     * Returns the token parser instances to add to the existing list.
+     *
+     * @return Twig_TokenParserInterface[]
      */
     public function getTokenParsers()
     {
@@ -26,7 +28,9 @@ class I18nExtension extends Twig_Extensions_Extension_I18n
     }
 
     /**
-     * {@inheritdoc}
+     * Returns a list of filters to add to the existing list.
+     *
+     * @return Twig_SimpleFilter[]
      */
     public function getFilters()
     {

libraries/twig/UrlExtension.php

@@ -18,7 +18,9 @@ use Twig_SimpleFunction;
 class UrlExtension extends Twig_Extension
 {
     /**
-     * {@inheritdoc}
+     * Returns a list of functions to add to the existing list.
+     *
+     * @return Twig_SimpleFunction[]
      */
     public function getFunctions()
     {

libraries/twig/i18n/NodeTrans.php

@@ -20,7 +20,18 @@ use Twig_Node_Expression;
 class NodeTrans extends Twig_Extensions_Node_Trans
 {
     /**
-     * {@inheritdoc}
+     * Constructor.
+     *
+     * The nodes are automatically made available as properties ($this->node).
+     * The attributes are automatically made available as array items ($this['name']).
+     *
+     * @param Twig_Node            $body    Body of node trans
+     * @param Twig_Node            $plural  Node plural
+     * @param Twig_Node_Expression $count   Node count
+     * @param Twig_Node            $context Node context
+     * @param Twig_Node            $notes   Node notes
+     * @param int                  $lineno  The line number
+     * @param string               $tag     The tag name associated with the Node
      */
     public function __construct(
         Twig_Node $body,
@@ -49,7 +60,11 @@ class NodeTrans extends Twig_Extensions_Node_Trans
     }
 
     /**
-     * {@inheritdoc}
+     * Compiles the node to PHP.
+     *
+     * @param Twig_Compiler $compiler Node compiler
+     *
+     * @return void
      */
     public function compile(Twig_Compiler $compiler)
     {

libraries/twig/i18n/TokenParserTrans.php

@@ -18,7 +18,13 @@ use Twig_Token;
 class TokenParserTrans extends Twig_Extensions_TokenParser_Trans
 {
     /**
-     * {@inheritdoc}
+     * Parses a token and returns a node.
+     *
+     * @param Twig_Token $token Twig token to parse
+     *
+     * @return Twig_NodeInterface
+     *
+     * @throws Twig_Error_Syntax
      */
     public function parse(Twig_Token $token)
     {
@@ -62,7 +68,11 @@ class TokenParserTrans extends Twig_Extensions_TokenParser_Trans
     }
 
     /**
-     * {@inheritdoc}
+     * Tests the current token for a type.
+     *
+     * @param Twig_Token $token Twig token to test
+     *
+     * @return bool
      */
     public function decideForFork(Twig_Token $token)
     {