Merge pull request #3 from SAP/jsdoc-update

Update jsdoc
SAP · Apr 12, 2018 · e286169 · e286169
2 parents 3ee1a19 + a458ac3
commit e286169
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 7 deletions.
diff --git a/lib/AbstractReaderWriter.js b/lib/AbstractReaderWriter.js
@@ -21,7 +21,7 @@ class AbstractReaderWriter extends AbstractReader {
 	 * Writes the content of a resource to a path.
 	 *
 	 * @param {Resource} resource The Resource to write
-	 * @returns {Promise} Promise resolving once data has been written
+	 * @returns {Promise<undefined>} Promise resolving once data has been written
 	 */
 	write(resource) {
 		return this._write(resource);
@@ -33,7 +33,7 @@ class AbstractReaderWriter extends AbstractReader {
 	 * @abstract
 	 * @protected
 	 * @param {Resource} resource The Resource to write
-	 * @returns {Promise} Promise resolving once data has been written
+	 * @returns {Promise<undefined>} Promise resolving once data has been written
 	 */
 	_write(resource) {
 		throw new Error("Not implemented");

diff --git a/lib/DuplexCollection.js b/lib/DuplexCollection.js
@@ -36,7 +36,7 @@ class DuplexCollection extends AbstractReaderWriter {
 	 * @param {string} virPattern GLOB pattern for virtual directory structure
 	 * @param {Object} options GLOB options
 	 * @param {Trace} trace Trace instance
-	 * @returns {Promise} Promise resolving to list of resources
+	 * @returns {Promise<Resource[]>} Promise resolving with a list of resources
 	 */
 	_byGlob(virPattern, options, trace) {
 		return this._combo._byGlob(virPattern, options, trace);
@@ -78,7 +78,7 @@ class DuplexCollection extends AbstractReaderWriter {
 	 *
 	 * @private
 	 * @param {Resource} resource The Resource to write
-	 * @returns {Promise} Promise resolving once data has been written
+	 * @returns {Promise<undefined>} Promise resolving once data has been written
 	 */
 	_write(resource) {
 		return this._writer.write(resource);

diff --git a/lib/adapters/AbstractAdapter.js b/lib/adapters/AbstractAdapter.js
@@ -10,6 +10,7 @@ const AbstractReaderWriter = require("../AbstractReaderWriter");
  */
 class AbstractAdapter extends AbstractReaderWriter {
 	/**
+	 * The constructor
 	 *
 	 * @param {Object} parameters Parameters
 	 * @param {string} parameters.virBasePath Virtual base path

diff --git a/lib/adapters/FileSystem.js b/lib/adapters/FileSystem.js
@@ -167,7 +167,7 @@ class FileSystem extends AbstractAdapter {
 	 *
 	 * @private
 	 * @param {Resource} resource The Resource
-	 * @returns {Promise} Promise resolving once data has been written
+	 * @returns {Promise<undefined>} Promise resolving once data has been written
 	 */
 	_write(resource) {
 		const relPath = resource.getPath().substr(this._virBasePath.length);

diff --git a/lib/adapters/Memory.js b/lib/adapters/Memory.js
@@ -99,7 +99,7 @@ class Memory extends AbstractAdapter {
 	 *
 	 * @private
 	 * @param {Resource} resource The Resource to write
-	 * @returns {Promise} Promise resolving once data has been written
+	 * @returns {Promise<undefined>} Promise resolving once data has been written
 	 */
 	_write(resource) {
 		return new Promise((resolve, reject) => {

diff --git a/lib/resourceFactory.js b/lib/resourceFactory.js
@@ -96,7 +96,7 @@ function createCollectionsForTree(tree, {useNamespaces=false} = {}) {
  * @param {Object} parameters Parameters
  * @param {string} parameters.virBasePath Virtual base path
  * @param {string} [parameters.fsBasePath] File system base path
- * @returns {(FileSystem|Memory)} File System- or Virtual Adapter
+ * @returns {FileSystem|Memory} File System- or Virtual Adapter
  */
 function createAdapter({fsBasePath, virBasePath, project}) {
 	if (fsBasePath) {