From 4f8f64af0d147ebe461d587c4748eb0bc86cf8fb Mon Sep 17 00:00:00 2001
From: wizonesolutions <wizonesolutions@739994.no-reply.drupal.org>
Date: Mon, 28 Mar 2022 12:57:05 -0400
Subject: [PATCH] Issue #3271313: Improve documentation for classes
---
src/Component/Helper/FillPdfMappingHelper.php | 2 +-
src/Component/Helper/FillPdfMappingHelperInterface.php | 2 +-
src/Component/Utility/FillPdf.php | 2 +-
src/Controller/HandlePdfController.php | 2 +-
src/EntityHelper.php | 2 +-
src/EntityHelperInterface.php | 2 +-
src/ExportableContentEntityInterface.php | 2 +-
src/FillPdfAccessHelper.php | 2 +-
src/FillPdfAccessHelperInterface.php | 2 +-
src/FillPdfAdminFormHelperInterface.php | 2 +-
src/FillPdfFormFieldInterface.php | 2 +-
src/FillPdfFormFieldViewsData.php | 2 +-
src/FillPdfFormInterface.php | 2 +-
src/FillPdfFormViewsData.php | 2 +-
src/Form/FillPdfAdminFormBase.php | 2 +-
src/Form/FillPdfFormConfirmFormBase.php | 2 +-
src/InputHelper.php | 2 +-
src/InputHelperInterface.php | 2 +-
src/OutputHandler.php | 2 +-
src/Serializer.php | 2 +-
src/SerializerInterface.php | 2 +-
src/Service/BackendProxy.php | 2 +-
src/TokenResolver.php | 2 +-
23 files changed, 23 insertions(+), 23 deletions(-)
diff --git a/src/Component/Helper/FillPdfMappingHelper.php b/src/Component/Helper/FillPdfMappingHelper.php
index 1822f0f..d1fd274 100644
--- a/src/Component/Helper/FillPdfMappingHelper.php
+++ b/src/Component/Helper/FillPdfMappingHelper.php
@@ -3,7 +3,7 @@
namespace Drupal\fillpdf\Component\Helper;
/**
- * Class FillPdfMappingHelper.
+ * {@inheritdoc}
*
* @package Drupal\fillpdf\Component\Helper
*/
diff --git a/src/Component/Helper/FillPdfMappingHelperInterface.php b/src/Component/Helper/FillPdfMappingHelperInterface.php
index eef9ead..44fd26c 100644
--- a/src/Component/Helper/FillPdfMappingHelperInterface.php
+++ b/src/Component/Helper/FillPdfMappingHelperInterface.php
@@ -3,7 +3,7 @@
namespace Drupal\fillpdf\Component\Helper;
/**
- * Interface FillPdfMappingHelperInterface.
+ * Helper functions for handling PDF transformations.
*
* @package Drupal\fillpdf\Component\Helper
*/
diff --git a/src/Component/Utility/FillPdf.php b/src/Component/Utility/FillPdf.php
index d0e4e21..f04fdc3 100644
--- a/src/Component/Utility/FillPdf.php
+++ b/src/Component/Utility/FillPdf.php
@@ -8,7 +8,7 @@ use GuzzleHttp\Client;
use Symfony\Component\Process\Process;
/**
- * Class FillPdf.
+ * Utility functions used throughout the module.
*
* @package Drupal\fillpdf\Component\Utility
*/
diff --git a/src/Controller/HandlePdfController.php b/src/Controller/HandlePdfController.php
index 8ec8934..1aabbb1 100644
--- a/src/Controller/HandlePdfController.php
+++ b/src/Controller/HandlePdfController.php
@@ -19,7 +19,7 @@ use Symfony\Component\HttpFoundation\RedirectResponse;
use Symfony\Component\HttpFoundation\RequestStack;
/**
- * Class HandlePdfController.
+ * Entry point for populating merging data into PDFs.
*/
class HandlePdfController extends ControllerBase {
diff --git a/src/EntityHelper.php b/src/EntityHelper.php
index ae333a0..fa59f39 100644
--- a/src/EntityHelper.php
+++ b/src/EntityHelper.php
@@ -3,7 +3,7 @@
namespace Drupal\fillpdf;
/**
- * Class EntityHelper.
+ * {@inheritdoc}
*
* @package Drupal\fillpdf
* @deprecated in fillpdf:8.x-4.7 and is removed from fillpdf:8.x-5.0. Applies
diff --git a/src/EntityHelperInterface.php b/src/EntityHelperInterface.php
index 5b259c3..04f2ef9 100644
--- a/src/EntityHelperInterface.php
+++ b/src/EntityHelperInterface.php
@@ -3,7 +3,7 @@
namespace Drupal\fillpdf;
/**
- * Interface EntityHelperInterface.
+ * Utility class for interacting with FillPDF forms.
*
* @package Drupal\fillpdf
* @deprecated in fillpdf:8.x-4.7 and is removed from fillpdf:8.x-5.0. Applies
diff --git a/src/ExportableContentEntityInterface.php b/src/ExportableContentEntityInterface.php
index 37d17bf..2e1cf4b 100644
--- a/src/ExportableContentEntityInterface.php
+++ b/src/ExportableContentEntityInterface.php
@@ -5,7 +5,7 @@ namespace Drupal\fillpdf;
use Drupal\Core\Entity\ContentEntityInterface;
/**
- * Interface ExportableContentEntityInterface.
+ * Lists exportable fields for implementing entities.
*
* @package Drupal\fillpdf
*/
diff --git a/src/FillPdfAccessHelper.php b/src/FillPdfAccessHelper.php
index 543a056..9589b07 100644
--- a/src/FillPdfAccessHelper.php
+++ b/src/FillPdfAccessHelper.php
@@ -7,7 +7,7 @@ use Drupal\Core\Session\AccountInterface;
use Drupal\Core\Url;
/**
- * Class FillPdfAccessHelper.
+ * {@inheritdoc}
*
* @package Drupal\fillpdf
*/
diff --git a/src/FillPdfAccessHelperInterface.php b/src/FillPdfAccessHelperInterface.php
index 730b569..4b529ad 100644
--- a/src/FillPdfAccessHelperInterface.php
+++ b/src/FillPdfAccessHelperInterface.php
@@ -6,7 +6,7 @@ use Drupal\Core\Session\AccountInterface;
use Drupal\Core\Url;
/**
- * Interface FillPdfAccessHelperInterface.
+ * Checks whether the configured permissions allow merging a PDF.
*
* @package Drupal\fillpdf
*/
diff --git a/src/FillPdfAdminFormHelperInterface.php b/src/FillPdfAdminFormHelperInterface.php
index bcf42b8..aa0a049 100644
--- a/src/FillPdfAdminFormHelperInterface.php
+++ b/src/FillPdfAdminFormHelperInterface.php
@@ -3,7 +3,7 @@
namespace Drupal\fillpdf;
/**
- * Interface FillPdfAdminFormHelperInterface.
+ * Common methods used on admin screens.
*
* @package Drupal\fillpdf
*/
diff --git a/src/FillPdfFormFieldInterface.php b/src/FillPdfFormFieldInterface.php
index 19cf60c..dad6fe5 100644
--- a/src/FillPdfFormFieldInterface.php
+++ b/src/FillPdfFormFieldInterface.php
@@ -3,7 +3,7 @@
namespace Drupal\fillpdf;
/**
- * Interface FillPdfFormFieldInterface.
+ * Represents a fillable field on a FillPDF form.
*
* @package Drupal\fillpdf
*/
diff --git a/src/FillPdfFormFieldViewsData.php b/src/FillPdfFormFieldViewsData.php
index 578534b..54b5d3c 100644
--- a/src/FillPdfFormFieldViewsData.php
+++ b/src/FillPdfFormFieldViewsData.php
@@ -5,7 +5,7 @@ namespace Drupal\fillpdf;
use Drupal\views\EntityViewsData;
/**
- * Class FillPdfFormFieldViewsData.
+ * Exposes form field metadata for the Views integration.
*
* @package Drupal\fillpdf
*/
diff --git a/src/FillPdfFormInterface.php b/src/FillPdfFormInterface.php
index bdf8585..42f4382 100644
--- a/src/FillPdfFormInterface.php
+++ b/src/FillPdfFormInterface.php
@@ -3,7 +3,7 @@
namespace Drupal\fillpdf;
/**
- * Interface FillPdfFormInterface.
+ * Represents a fillable PDF form.
*
* @package Drupal\fillpdf
*/
diff --git a/src/FillPdfFormViewsData.php b/src/FillPdfFormViewsData.php
index 06c269f..80d246e 100644
--- a/src/FillPdfFormViewsData.php
+++ b/src/FillPdfFormViewsData.php
@@ -5,7 +5,7 @@ namespace Drupal\fillpdf;
use Drupal\views\EntityViewsData;
/**
- * Class FillPdfFormViewsData.
+ * Exposes form metadata for the Views integration.
*
* @package Drupal\fillpdf
*/
diff --git a/src/Form/FillPdfAdminFormBase.php b/src/Form/FillPdfAdminFormBase.php
index f99a3f1..59d59ca 100644
--- a/src/Form/FillPdfAdminFormBase.php
+++ b/src/Form/FillPdfAdminFormBase.php
@@ -7,7 +7,7 @@ use Drupal\Core\Form\FormBase;
@trigger_error('FillPdfAdminFormBase is deprecated in fillpdf:8.x-4.7 and is removed from fillpdf:8.x-5.0. Use \Drupal\Core\Form\FormBase instead. See https://www.drupal.org/project/fillpdf/issues/3044743', E_USER_DEPRECATED);
/**
- * Class FillPdfAdminFormBase.
+ * Base class for administrative forms.
*
* @package Drupal\fillpdf\Form
*
diff --git a/src/Form/FillPdfFormConfirmFormBase.php b/src/Form/FillPdfFormConfirmFormBase.php
index 12e9d23..99e7d16 100644
--- a/src/Form/FillPdfFormConfirmFormBase.php
+++ b/src/Form/FillPdfFormConfirmFormBase.php
@@ -6,7 +6,7 @@ use Drupal\Core\Entity\ContentEntityConfirmFormBase;
use Drupal\Core\Form\FormStateInterface;
/**
- * Class FillPdfFormConfirmFormBase.
+ * Base class for confirmation forms.
*
* @package Drupal\fillpdf\Form
*/
diff --git a/src/InputHelper.php b/src/InputHelper.php
index 0a11f4b..f0ab39b 100644
--- a/src/InputHelper.php
+++ b/src/InputHelper.php
@@ -10,7 +10,7 @@ use Drupal\fillpdf\Entity\FillPdfFormField;
use Drupal\fillpdf\Plugin\PdfBackendManager;
/**
- * Class InputHelper.
+ * {@inheritdoc}
*
* @package Drupal\fillpdf
*/
diff --git a/src/InputHelperInterface.php b/src/InputHelperInterface.php
index 60b2636..bb9258d 100644
--- a/src/InputHelperInterface.php
+++ b/src/InputHelperInterface.php
@@ -5,7 +5,7 @@ namespace Drupal\fillpdf;
use Drupal\file\FileInterface;
/**
- * Interface InputHelperInterface.
+ * Helper methods for PDF uploads.
*
* @package Drupal\fillpdf
*/
diff --git a/src/OutputHandler.php b/src/OutputHandler.php
index 37de557..36bc821 100644
--- a/src/OutputHandler.php
+++ b/src/OutputHandler.php
@@ -10,7 +10,7 @@ use Psr\Log\LoggerInterface;
use Drupal\Core\File\FileSystemInterface;
/**
- * Class OutputHandler.
+ * {@inheritdoc}
*
* @package Drupal\fillpdf
*/
diff --git a/src/Serializer.php b/src/Serializer.php
index c1c724e..6538b7a 100644
--- a/src/Serializer.php
+++ b/src/Serializer.php
@@ -6,7 +6,7 @@ use Drupal\Core\Entity\EntityTypeManagerInterface;
use Symfony\Component\Serializer\Serializer as SymfonySerializer;
/**
- * Class Serializer.
+ * {@inheritdoc}
*
* @package Drupal\fillpdf
*/
diff --git a/src/SerializerInterface.php b/src/SerializerInterface.php
index fe5be51..d693151 100644
--- a/src/SerializerInterface.php
+++ b/src/SerializerInterface.php
@@ -3,7 +3,7 @@
namespace Drupal\fillpdf;
/**
- * Interface SerializerInterface.
+ * Handles exporting and importing FillPDF forms.
*
* @package Drupal\fillpdf
*/
diff --git a/src/Service/BackendProxy.php b/src/Service/BackendProxy.php
index f908267..ac850e6 100644
--- a/src/Service/BackendProxy.php
+++ b/src/Service/BackendProxy.php
@@ -11,7 +11,7 @@ use Drupal\fillpdf\Plugin\PdfBackendManager;
use Drupal\fillpdf\TokenResolverInterface;
/**
- * BackendProxy service.
+ * {@inheritdoc}
*/
class BackendProxy implements BackendProxyInterface {
diff --git a/src/TokenResolver.php b/src/TokenResolver.php
index f51b3f8..bbc6a02 100644
--- a/src/TokenResolver.php
+++ b/src/TokenResolver.php
@@ -15,7 +15,7 @@ use Drupal\fillpdf\FieldMapping\TextFieldMapping;
use Drupal\token\TokenEntityMapperInterface;
/**
- * Class TokenResolver.
+ * {@inheritdoc}
*
* @package Drupal\fillpdf
*/
--
GitLab