chore: documentation

Signed-off-by: gbrousse-recia <[email protected]>

lib/Mount/GroupFolderPropagator.php

@@ -46,6 +46,8 @@ class GroupFolderPropagator extends Propagator {
 
 	/**
 	 * @param \OCA\GroupFolders\Mount\GroupFolderStorage $storage
+	 * @param \OCP\IDBConnection $connection
+	 * @param \OCP\ILogger $logger
 	 */
 	public function __construct(\OC\Files\Storage\Storage $storage, IDBConnection $connection, ILogger $logger) {
 		parent::__construct($storage, $connection);
@@ -54,6 +56,12 @@ public function __construct(\OC\Files\Storage\Storage $storage, IDBConnection $c
 		$this->logger = $logger;
 	}
 
+	/**
+	 * get paths of parent directories
+	 *
+	 * @param string $pathOrigin
+	 * @return array
+	 */
 	protected function getParents($pathOrigin) {
 		$groupFolderPath = $this->getGroupFolderMountPoint($this->folderId);
 		if(!strstr($pathOrigin,$groupFolderPath)){
@@ -75,6 +83,11 @@ protected function getParents($pathOrigin) {
 		return $fullParents;
 	}
 
+	/**
+	 * get all parent groupfolders of the current groupfolder
+	 *
+	 * @return array
+	 */
 	protected function getGroupFolderParents(){
 		// Get folder mountpoint
 		$query = $this->connection->getQueryBuilder();
@@ -101,6 +114,12 @@ protected function getGroupFolderParents(){
 		,$parentsIds);
 	}
 
+	/**
+	 * get the groupfolder mount point
+	 *
+	 * @param int $groupFolderId
+	 * @return string
+	 */
 	protected function getGroupFolderMountPoint($groupFolderId){
 		return '__groupfolders/'.$groupFolderId;
 	}

lib/Mount/GroupFolderStorage.php

@@ -1,6 +1,7 @@
 <?php
 /**
  * @copyright Copyright (c) 2018 Robin Appelman <[email protected]>
+ * @copyright Copyright (c) 2023, Grégory Brousse <[email protected]>
  *
  * @license GNU AGPL version 3 or any later version
  *