Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[INTERNAL] Workspace: Correct JSDoc #568

Merged
merged 1 commit into from
Feb 7, 2023
Merged

[INTERNAL] Workspace: Correct JSDoc #568

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions lib/graph/Workspace.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,27 +11,28 @@ const log = getLogger("graph:Workspace");


/**
* Dependency graph node representing a module
* Workspace configuration. For details, refer to the
* [UI5 Workspaces documentation]{@link https://sap.github.io/ui5-tooling/v3/pages/Workspace/#configuration}
*
* @public
* @typedef {object} @ui5/project/graph/Workspace~Configuration
* @property {string} node.specVersion
* @property {object} node.metadata Version of the project
* @property {string} node.specVersion Workspace Specification Version
* @property {object} node.metadata
* @property {string} node.metadata.name Name of the workspace configuration
* @property {object} node.dependencyManagement
* @property {@ui5/project/graph/Workspace~DependencyManagementResolutions[]} node.dependencyManagement.resolutions
*/

/**
* A resolution entry for the dependency management section of the configuration
* A resolution entry for the dependency management section of the workspace configuration
*
* @public
* @typedef {object} @ui5/project/graph/Workspace~DependencyManagementResolution
* @property {string} path Relative path to use for the workspace resolution process
*/

/**
* Workspace representation
* UI5 Workspace
*
* @public
* @class
Expand Down