[INTERNAL] Update Reader JSDocs

lib/AbstractReader.js

@@ -21,17 +21,17 @@ class AbstractReader {
 	}
 
 	/**
-	 * Locates resourcess by GLOB.
+	 * Locates resources by matching GLOB patterns.
 	 *
 	 * @example
-	 * <caption>Example patterns:</caption>
-	 * // **\u00002F*.{html,htm}
-	 * // **\u00002F.library
-	 * // /pony/*
+	 * byGlob("**‏/*.{html,htm}");
+	 * byGlob("**‏/.library");
+	 * byGlob("/pony/*");
 	 *
 	 * @public
-	 * @param {string|Array} virPattern GLOB pattern as string or array of glob patterns for virtual directory structure
-	 * @param {Object} [options={}] GLOB options
+	 * @param {string|string[]} virPattern GLOB pattern as string or array of glob patterns for
+	 * 										virtual directory structure
+	 * @param {Object} [options] GLOB options
 	 * @param {boolean} [options.nodir=true] Do not match directories
 	 * @returns {Promise<module:@ui5/fs.Resource[]>} Promise resolving to list of resources
 	 */
@@ -54,11 +54,11 @@ class AbstractReader {
 	}
 
 	/**
-	 * Locates resources by path.
+	 * Locates resources by matching a given path.
 	 *
 	 * @public
 	 * @param {string} virPath Virtual path
-	 * @param {Object} options Options
+	 * @param {Object} [options] Options
 	 * @param {boolean} [options.nodir=true] Do not match directories
 	 * @returns {Promise<module:@ui5/fs.Resource>} Promise resolving to a single resource
 	 */
@@ -75,7 +75,8 @@ class AbstractReader {
 	 *
 	 * @abstract
 	 * @protected
-	 * @param {string} virPattern GLOB pattern for virtual directory structure
+	 * @param {string|string[]} virPattern GLOB pattern as string or an array of
+	 *         glob patterns for virtual directory structure
 	 * @param {Object} options GLOB options
 	 * @param {module:@ui5/fs.tracing.Trace} trace Trace instance
 	 * @returns {Promise<module:@ui5/fs.Resource[]>} Promise resolving to list of resources

lib/DuplexCollection.js

@@ -35,7 +35,8 @@ class DuplexCollection extends AbstractReaderWriter {
 	 * Locates resources by GLOB.
 	 *
 	 * @private
-	 * @param {string} virPattern GLOB pattern for virtual directory structure
+	 * @param {string|string[]} virPattern GLOB pattern as string or an array of
+	 *         glob patterns for virtual directory structure
 	 * @param {Object} options GLOB options
 	 * @param {module:@ui5/fs.tracing.Trace} trace Trace instance
 	 * @returns {Promise<module:@ui5/fs.Resource[]>} Promise resolving with a list of resources
@@ -49,10 +50,11 @@ class DuplexCollection extends AbstractReaderWriter {
 	 * For found resources that are also available in the writer, the writer resource will be returned.
 	 *
 	 * @param {string} virPattern GLOB pattern for virtual directory structure
-	 * @param {Object} [options={}] GLOB options
+	 * @param {Object} [options] GLOB options
+	 * @param {boolean} [options.nodir=true] Do not match directories
 	 * @returns {Promise<module:@ui5/fs.Resource[]>} Promise resolving to list of resources
 	 */
-	byGlobSource(virPattern, options = {}) {
+	byGlobSource(virPattern, options = {nodir: true}) {
 		return this._reader.byGlob(virPattern, options).then((resources) => {
 			return Promise.all(resources.map((readerResource) => {
 				return this._writer.byPath(readerResource.getPath()).then((writerResource) => {

lib/ReaderCollection.js

@@ -25,7 +25,8 @@ class ReaderCollection extends AbstractReader {
 	 * Locates resources by GLOB.
 	 *
 	 * @private
-	 * @param {string} pattern GLOB pattern
+	 * @param {string|string[]} pattern GLOB pattern as string or an array of
+	 *         glob patterns for virtual directory structure
 	 * @param {Object} options GLOB options
 	 * @param {module:@ui5/fs.tracing.Trace} trace Trace instance
 	 * @returns {Promise<module:@ui5/fs.Resource[]>} Promise resolving to list of resources

lib/ReaderCollectionPrioritized.js

@@ -13,7 +13,8 @@ class ReaderCollectionPrioritized extends AbstractReader {
 	 *
 	 * @param {Object} parameters
 	 * @param {string} parameters.name The collection name
-	 * @param {module:@ui5/fs.AbstractReader[]} parameters.readers Prioritized list of resource readers (first is tried first)
+	 * @param {module:@ui5/fs.AbstractReader[]} parameters.readers Prioritized list of resource readers
+	 * 																(first is tried first)
 	 */
 	constructor({readers, name}) {
 		super();
@@ -25,7 +26,8 @@ class ReaderCollectionPrioritized extends AbstractReader {
 	 * Locates resources by GLOB.
 	 *
 	 * @private
-	 * @param {string} pattern GLOB pattern
+	 * @param {string|string[]} pattern GLOB pattern as string or an array of
+	 *         glob patterns for virtual directory structure
 	 * @param {Object} options GLOB options
 	 * @param {module:@ui5/fs.tracing.Trace} trace Trace instance
 	 * @returns {Promise<module:@ui5/fs.Resource[]>} Promise resolving to list of resources

lib/adapters/AbstractAdapter.js

@@ -34,7 +34,7 @@ class AbstractAdapter extends AbstractReaderWriter {
 	 *
 	 * @abstract
 	 * @private
-	 * @param {string|Array} virPattern GLOB pattern as string or an array of
+	 * @param {string|string[]} virPattern GLOB pattern as string or an array of
 	 *         glob patterns for virtual directory structure
 	 * @param {Object} [options={}] GLOB options
 	 * @param {boolean} [options.nodir=true] Do not match directories

lib/adapters/FileSystem.js

@@ -109,7 +109,7 @@ class FileSystem extends AbstractAdapter {
 	 * @param {string} virPath Virtual path
 	 * @param {Object} options Options
 	 * @param {module:@ui5/fs.tracing.Trace} trace Trace instance
-	 * @returns {Promise<module:@ui5/fs.Resource>} Promise resolving to a single resource
+	 * @returns {Promise<module:@ui5/fs.Resource>} Promise resolving to a single resource or null if not found
 	 */
 	_byPath(virPath, options, trace) {
 		return new Promise((resolve, reject) => {

test/lib/DuplexCollection.js

@@ -132,7 +132,7 @@ test("DuplexCollection: _byGlobSource with default options and a reader finding
 	return duplexCollection.byGlobSource("anyPattern")
 		.then(function(resources) {
 			t.true(Array.isArray(resources), "Found resources are returned as an array");
-			t.true(abstractReader.byGlob.calledWithExactly("anyPattern", {}),
+			t.true(abstractReader.byGlob.calledWithExactly("anyPattern", {nodir: true}),
 				"Delegated globbing task correctly to readers");
 			t.true(abstractWriter.byPath.calledWithExactly("my/path"),
 				"byPath called on writer");