Minor cleanup and docstrings

Icinga · Oct 1, 2024 · f306236 · f306236
1 parent 7331cf4
commit f306236
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 4 deletions.
diff --git a/configuration.php b/configuration.php
@@ -3,9 +3,6 @@
 
 /** @var \Icinga\Application\Modules\Module $this */
 
-use Icinga\Module\Toplevelview\ViewConfig;
-use Icinga\Web\Url;
-
 $this->providePermission('toplevelview/edit', $this->translate('Allow the user to edit Top Level Views'));
 
 $this->provideRestriction(

diff --git a/library/Toplevelview/Model/View.php b/library/Toplevelview/Model/View.php
@@ -9,7 +9,8 @@
 use Icinga\Module\Toplevelview\Tree\TLVTree;
 
 /**
- * View represents a single Top Level View
+ * View represents a single Top Level View.
+ * It contains the actual Tree and metadata.
  */
 class View
 {

diff --git a/library/Toplevelview/Tree/TLVIcingaNode.php b/library/Toplevelview/Tree/TLVIcingaNode.php
@@ -6,6 +6,7 @@
 use Icinga\Exception\NotImplementedError;
 
 /**
+ * Leaves nodes that fetch data from the database are TLVIcingaNodes.
  * @codeCoverageIgnore
  */
 class TLVIcingaNode extends TLVTreeNode

diff --git a/library/Toplevelview/Tree/TLVTreeNode.php b/library/Toplevelview/Tree/TLVTreeNode.php
@@ -21,6 +21,9 @@ class TLVTreeNode extends TreeNode
      */
     protected $type = 'node';
 
+    /**
+     * @var string
+     */
     protected $key = null;
 
     /**
@@ -48,6 +51,11 @@ class TLVTreeNode extends TreeNode
      */
     protected $properties = array();
 
+    /**
+     * Determine if this node is a leaf
+     *
+     * @var bool
+     */
     protected static $canHaveChildren = true;
 
     /**

diff --git a/library/Toplevelview/Util/Str.php b/library/Toplevelview/Util/Str.php
@@ -6,6 +6,7 @@ class Str
 {
     /**
      * Str::limit method truncates the given string to the specified length.
+     * Used in cases where CSS text-overflow cannot be used.
      *
      * @param   string $str
      * @param   int    $len