From 9028055d8b6d90530c2c37ae7efd28d235eaf64a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Maur=C3=ADcio=20Meneghini=20Fauth?=
 <mauriciofauth@gmail.com>
Date: Mon, 10 Apr 2017 18:36:02 -0300
Subject: [PATCH] Fix some coding standard errors in DocBlocks
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Maurício Meneghini Fauth <mauriciofauth@gmail.com>
---
 examples/openid.php                        |  7 +++++++
 libraries/plugins/export/PMA_ExportPdf.php |  1 +
 libraries/plugins/schema/pdf/Pdf.php       |  2 ++
 libraries/twig/I18nExtension.php           |  8 ++++++--
 libraries/twig/UrlExtension.php            |  4 +++-
 libraries/twig/i18n/NodeTrans.php          | 19 +++++++++++++++++--
 libraries/twig/i18n/TokenParserTrans.php   | 14 ++++++++++++--
 7 files changed, 48 insertions(+), 7 deletions(-)

diff --git a/examples/openid.php b/examples/openid.php
index a87c1b19a8..1d15a07000 100644
--- a/examples/openid.php
+++ b/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";
diff --git a/libraries/plugins/export/PMA_ExportPdf.php b/libraries/plugins/export/PMA_ExportPdf.php
index c553be6281..409a302ae8 100644
--- a/libraries/plugins/export/PMA_ExportPdf.php
+++ b/libraries/plugins/export/PMA_ExportPdf.php
@@ -86,6 +86,7 @@ class PMA_ExportPdf extends PDF
      *
      * @return void
      */
+    // @codingStandardsIgnoreLine
     public function Header()
     {
         global $maxY;
diff --git a/libraries/plugins/schema/pdf/Pdf.php b/libraries/plugins/schema/pdf/Pdf.php
index 67178c4b74..6a3721c952 100644
--- a/libraries/plugins/schema/pdf/Pdf.php
+++ b/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) {
diff --git a/libraries/twig/I18nExtension.php b/libraries/twig/I18nExtension.php
index cfe4734a7b..73884d11bb 100644
--- a/libraries/twig/I18nExtension.php
+++ b/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()
     {
diff --git a/libraries/twig/UrlExtension.php b/libraries/twig/UrlExtension.php
index 0994a152cc..839caa6cb3 100644
--- a/libraries/twig/UrlExtension.php
+++ b/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()
     {
diff --git a/libraries/twig/i18n/NodeTrans.php b/libraries/twig/i18n/NodeTrans.php
index 717989a5b9..6bc1269cbf 100644
--- a/libraries/twig/i18n/NodeTrans.php
+++ b/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)
     {
diff --git a/libraries/twig/i18n/TokenParserTrans.php b/libraries/twig/i18n/TokenParserTrans.php
index 0f1181f5fc..939e2097c6 100644
--- a/libraries/twig/i18n/TokenParserTrans.php
+++ b/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)
     {