JSdoc and test cleanup

Author: RandomByte

index.js

@@ -55,7 +55,22 @@ module.exports = {
 		 * @type {import('./lib/translators/static')}
 		 */
 		static: "./lib/translators/static"
-	}
+	},
+	/**
+	 * @public
+	 * @alias module:@ui5/project.graph
+	 * @namespace
+	 */
+	graph: {
+		/**
+		 * @type {typeof import('./lib/graph/ProjectGraph')}
+		 */
+		ProjectGraph: "./lib/graph/ProjectGraph",
+		/**
+		 * @type {typeof import('./lib/graph/projectGraphFromTree')}
+		 */
+		projectGraphFromTree: "./lib/graph/projectGraphFromTree"
+	},
 };
 
 function exportModules(exportRoot, modulePaths) {

lib/graph/Module.js

@@ -16,16 +16,23 @@ const defaultConfigPath = "ui5.yaml";
 function clone(obj) {
 	return JSON.parse(JSON.stringify(obj));
 }
-
+/**
+ * Raw representation of a UI5 Project. A module can contain zero to one projects and n extensions.
+ * This class is intended for private use by the
+ * [@ui5/project.graph.projectGraphFromTree]{@link module:@ui5/project.graph.projectGraphFromTree} module
+ *
+ * @private
+ * @memberof module:@ui5/project.graph
+ */
 class Module {
 	/**
 	 * @param {object} parameters Module parameters
-	 * @param {string} parameters.id Unique ID for the project
-	 * @param {string} parameters.version Version of the project
+	 * @param {string} parameters.id Unique ID for the module
+	 * @param {string} parameters.version Version of the module
 	 * @param {string} parameters.modulePath File System path to access the projects resources
 	 * @param {string} [parameters.configPath=ui5.yaml]
 	 *						Either a path relative to `modulePath` which will be resolved by @ui5/fs (default),
-	 *						or an absolute File System path to the project configuration file.
+	 *						or an absolute File System path to the configuration file.
 	 * @param {object|object[]} [parameters.configuration]
 	 * 						Configuration object or array of objects to use. If supplied, no ui5.yaml will be read
 	 * @param {@ui5/project.graph.ShimCollection} [parameters.shimCollection]
@@ -63,23 +70,14 @@ class Module {
 		}
 	}
 
-	/**
-	* @private
-	*/
 	getId() {
 		return this._id;
 	}
 
-	/**
-	* @private
-	*/
 	getVersion() {
 		return this._version;
 	}
 
-	/**
-	* @private
-	*/
 	getPath() {
 		return this._modulePath;
 	}

lib/graph/ProjectGraph.js

@@ -1,6 +1,6 @@
 const log = require("@ui5/logger").getLogger("graph:ProjectGraph");
 /**
- * A rooted, directed graph representing a UI5 project and all its dependencies
+ * A rooted, directed graph representing a UI5 project, its dependencies and available extensions
  *
  * @public
  * @memberof module:@ui5/project.graph

lib/graph/projectGraphFromTree.js

@@ -4,7 +4,6 @@ const ProjectGraph = require("./ProjectGraph");
 const ShimCollection = require("./ShimCollection");
 const log = require("@ui5/logger").getLogger("graph:projectGraphFromTree");
 
-
 function _handleExtensions(graph, shimCollection, extensions) {
 	extensions.forEach((extension) => {
 		const type = extension.getType();
@@ -38,7 +37,13 @@ function _handleExtensions(graph, shimCollection, extensions) {
  */
 
 /**
+ * Helper module to create a [@ui5/project.graph.ProjectGraph]{@link module:@ui5/project.graph.ProjectGraph}
+ * from a dependency tree as returned by translators.
+ *
+ * @public
+ * @alias module:@ui5/project.graph.projectGraphFromTree
  * @param {TreeNode} tree Dependency tree as returned by a translator
+ * @returns {module:@ui5/project.graph.ProjectGraph} A new project graph instance
  */
 module.exports = async function(tree) {
 	const shimCollection = new ShimCollection();

test/lib/graph/projectGraphFromTree.js

@@ -10,18 +10,13 @@ const applicationBPath = path.join(__dirname, "..", "..", "fixtures", "applicati
 const applicationCPath = path.join(__dirname, "..", "..", "fixtures", "application.c");
 const libraryAPath = path.join(__dirname, "..", "..", "fixtures", "collection", "library.a");
 const libraryBPath = path.join(__dirname, "..", "..", "fixtures", "collection", "library.b");
-// const libraryCPath = path.join(__dirname, "..", "..", "fixtures", "collection", "library.c");
 const libraryDPath = path.join(__dirname, "..", "..", "fixtures", "library.d");
 const cycleDepsBasePath = path.join(__dirname, "..", "..", "fixtures", "cyclic-deps", "node_modules");
 const pathToInvalidModule = path.join(__dirname, "..", "..", "fixtures", "invalidModule");
 
 const legacyLibraryAPath = path.join(__dirname, "..", "fixtures", "legacy.library.a");
 const legacyLibraryBPath = path.join(__dirname, "..", "fixtures", "legacy.library.b");
 const legacyCollectionAPath = path.join(__dirname, "..", "fixtures", "legacy.collection.a");
-const legacyCollectionLibraryX = path.join(__dirname, "..", "fixtures", "legacy.collection.a",
-	"src", "legacy.library.x");
-const legacyCollectionLibraryY = path.join(__dirname, "..", "fixtures", "legacy.collection.a",
-	"src", "legacy.library.y");
 
 test.beforeEach((t) => {
 	const sinon = t.context.sinon = sinonGlobal.createSandbox();