Docstring formating

Author: TheSyscall

library/Icinga/Web/Form/ConfigForm.php

@@ -61,6 +61,8 @@ public function ensureAssembled(): static
      * Populate the form elements from the configuration
      *
      * @return void
+     *
+     * @throws ProgrammingError
      */
     protected function populateFromConfig(): void
     {
@@ -84,7 +86,7 @@ protected function populateFromConfig(): void
     }
 
     /**
-     * Get the section and key from the element name.
+     * Get the section and key from the element name
      *
      * @param string $name The element name
      *
@@ -122,7 +124,10 @@ public function getConfigValue(string $name, mixed $default = null): mixed
     /**
      * Persist the current configuration to disk
      *
-     * If an error occurs, the form will be re-rendered with the error message and the raw INI configuration.
+     * If an error occurs, the form will be re-rendered with the error message
+     * and the raw INI configuration.
+     *
+     * @throws ProgrammingError
      */
     protected function save(): void
     {
@@ -176,7 +181,7 @@ protected function onSuccess(): void
     }
 
     /**
-     * Add the store button to the form.
+     * Add the store button to the form
      *
      * @return void
      */

library/Icinga/Web/Form/ConfigSectionForm.php

@@ -144,8 +144,10 @@ public function setAllowDeletion(bool $allowDeletion = true): static
     }
 
     /**
-     * Is the form allowed to delete the configuration section.
+     * Whether the form is allowed to delete the configuration section
+     *
      * Note: Creation forms are never allowed to be deleted.
+     *
      * @return bool
      */
     public function allowDeletion(): bool
@@ -157,13 +159,27 @@ public function allowDeletion(): bool
         return $this->allowDeletion;
     }
 
+    /**
+     * Set the ability to rename the configuration section
+     *
+     * @param bool $allowRename Whether the form is allowed to rename the configuration section
+     *
+     * @return $this
+     */
     public function setAllowRename(bool $allowRename = true): static
     {
         $this->allowRename = $allowRename;
 
         return $this;
     }
 
+    /**
+     * Whether the form is allowed to rename the configuration section
+     *
+     * Note: Creation forms are never allowed to be rename forms.
+     *
+     * @return bool
+     */
     public function allowRename(): bool
     {
         if ($this->isCreateForm()) {
@@ -181,6 +197,8 @@ public function allowRename(): bool
      * This is done to allow for deletion of sections that contain invalid configuration.
      *
      * @return void
+     *
+     * @throws ProgrammingError
      */
     protected function handleDelete(): void
     {
@@ -212,6 +230,8 @@ protected function handleDelete(): void
      * It renames the underlying section and updates the section name in the form.
      *
      * @return void
+     *
+     * @throws ProgrammingError
      */
     protected function handleRename(): void
     {
@@ -255,9 +275,11 @@ public function hasDeleteButton(): bool
     }
 
     /**
-     * Add the section name element to the form. This element is used to create
-     * a new configuration section with the given name. The added element
-     * automatically validates that the name is unique within the configuration.
+     * Add the section name element to the form
+     *
+     * This element is used to create a new configuration section with the given
+     * name. The added element automatically validates that the name is unique
+     * within the configuration.
      *
      * @param array $params Additional parameters to pass to the element constructor
      *
@@ -300,13 +322,6 @@ protected function addSectionNameElement(array $params = []): void
         $this->addElement('text', static::NAME_ELEMENT_NAME, $params);
     }
 
-    /**
-     * Get the section and key from the element name.
-     *
-     * @param string $name The element name
-     *
-     * @return string[]|null
-     */
     protected function getIniKeyFromName(string $name): ?array
     {
         return [$this->section, $name];
@@ -340,11 +355,6 @@ protected function onSuccess(): void
         }
     }
 
-    /**
-     * Add the store and optionally the delete buttons to the form.
-     *
-     * @return void
-     */
     protected function addButtonElements(): void
     {
         parent::addButtonElements();
@@ -367,6 +377,11 @@ protected function addButtonElements(): void
             ->prepend($deleteButton);
     }
 
+    /**
+     * Check if the form should rename the section for this request
+     *
+     * @return bool
+     */
     private function shouldRename(): bool
     {
         if (! $this->allowRename() || ! $this->hasBeenSubmitted() || ! $this->isValid()) {