[GT-184] Update comments

GOCDB · Aug 7, 2023 · 5728cd9 · 5728cd9
1 parent e5318ab
commit 5728cd9
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 3 deletions.
diff --git a/htdocs/web_portal/views/site/edit_api_auth.php b/htdocs/web_portal/views/site/edit_api_auth.php
@@ -29,7 +29,7 @@
             if ($params['isRenewalRequest']) {
                 echo("WARNING: Renewing this will change the linked user from '");
             } else {
-                echo("WARNING: editing will change the linked user from '");
+                echo("WARNING: Editing will change the linked user from '");
             }
             xecho($entUser->getFullname());
             echo("' to '");
@@ -79,7 +79,7 @@ class="input_input_text"
         <?php if (!($params['isRenewalRequest'])) {?>
         <div style="margin-bottom: 1em">
             <div class="input_warning">
-                WARNING: it is possible to delete information using the write functionality of the API.
+                WARNING: It is possible to delete information using the write functionality of the API.
                 Leave Allow API write unchecked if you do not need to write data.
             </div>
 

diff --git a/lib/Gocdb_Services/APIAuthenticationService.php b/lib/Gocdb_Services/APIAuthenticationService.php
@@ -152,7 +152,7 @@ public function deleteAPIAuthentication(\APIAuthentication $authEntity)
      *
      * @param \APIAuthentication Entity to update
      * @param \User Owning user
-     * @param mixed $newValues Holds the new values.
+     * @param mixed $newValues Holds the new data for updating the `APIAuthentication` entity.
      *
      * @throws \Exception on error with commit rolled back
      */

diff --git a/lib/Gocdb_Services/Site.php b/lib/Gocdb_Services/Site.php
@@ -1429,6 +1429,13 @@ public function deleteAPIAuthEntity(\APIAuthentication $authEntity, \User $user)
         $authEntServ->deleteAPIAuthentication($authEntity);
     }
 
+    /**
+     * Helper to edit an `APIAuthentication` entity.
+     *
+     * @param \APIAuthentication $authEntity `APIAuthentication` entity to check.
+     * @param \User $user User doing the edit.
+     * @param mixed $newValues Holds the new data for updating the `APIAuthentication` entity.
+     */
     public function editAPIAuthEntity(\APIAuthentication $authEntity, \User $user, $newValues)
     {
         $parentSite = $authEntity->getParentSite();