docs: fix jsdoc issues with module tag

phcode-dev · Nov 11, 2024 · 14cf7e8 · 14cf7e8
1 parent 43dc70e
commit 14cf7e8
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 49 deletions.
diff --git a/docs/API-Reference/filesystem/FileSystemError.md b/docs/API-Reference/filesystem/FileSystemError.md
@@ -3,60 +3,33 @@
 const FileSystemError = brackets.getModule("filesystem/FileSystemError")
 ```
 
-<a name="FileSystemError FileSystemError
-
+<a name="module_FileSystemError"></a>
 
+## FileSystemError
 FileSystemError describes the errors that can occur when using the FileSystem, File,
 and Directory modules.
 
-Error values are strings. Any falsy value_ null, undefined or  means no error.
+Error values are strings. Any "falsy" value: null, undefined or "" means "no error".
 
 Enumerated File System Errors
-```js
-        UNKNOWN_ Unknown,
-        INVALID_PARAMS_ InvalidParams,
-        NOT_FOUND_ NotFound,
-        NOT_READABLE_ NotReadable,
-        UNSUPPORTED_ENCODING_ UnsupportedEncoding,
-        NOT_SUPPORTED_ NotSupported,
-        NOT_WRITABLE_ NotWritable,
-        OUT_OF_SPACE_ OutOfSpace,
-        TOO_MANY_ENTRIES_ TooManyEntries,
-        ALREADY_EXISTS_ AlreadyExists,
-        CONTENTS_MODIFIED_ ContentsModified,
-        ROOT_NOT_WATCHED_ RootNotBeingWatched,
-        EXCEEDS_MAX_FILE_SIZE_ ExceedsMaxFileSize,
-        NETWORK_DRIVE_NOT_SUPPORTED_ NetworkDriveNotSupported,
-        ENCODE_FILE_FAILED_ EncodeFileFailed,
-        DECODE_FILE_FAILED_ DecodeFileFailed,
-        UNSUPPORTED_UTF16_ENCODING_ UnsupportedUTF16Encoding
- ```module_"></a>
-
-## FileSystemError FileSystemError
-
-
-FileSystemError describes the errors that can occur when using the FileSystem, File,
-and Directory modules.
-
-Error values are strings. Any falsy value: null, undefined or  means no error.
 
-Enumerated File System Errors
 ```js
-        UNKNOWN: Unknown,
-        INVALID\_PARAMS: InvalidParams,
-        NOT\_FOUND: NotFound,
-        NOT\_READABLE: NotReadable,
-        UNSUPPORTED\_ENCODING: UnsupportedEncoding,
-        NOT\_SUPPORTED: NotSupported,
-        NOT\_WRITABLE: NotWritable,
-        OUT\_OF\_SPACE: OutOfSpace,
-        TOO\_MANY\_ENTRIES: TooManyEntries,
-        ALREADY\_EXISTS: AlreadyExists,
-        CONTENTS\_MODIFIED: ContentsModified,
-        ROOT\_NOT\_WATCHED: RootNotBeingWatched,
-        EXCEEDS\_MAX\_FILE\_SIZE: ExceedsMaxFileSize,
-        NETWORK\_DRIVE\_NOT\_SUPPORTED: NetworkDriveNotSupported,
-        ENCODE\_FILE\_FAILED: EncodeFileFailed,
-        DECODE\_FILE\_FAILED: DecodeFileFailed,
-        UNSUPPORTED\_UTF16\_ENCODING: UnsupportedUTF16Encoding
+        UNKNOWN: "Unknown",
+        INVALID_PARAMS: "InvalidParams",
+        NOT_FOUND: "NotFound",
+        NOT_READABLE: "NotReadable",
+        UNSUPPORTED_ENCODING: "UnsupportedEncoding",
+        NOT_SUPPORTED: "NotSupported",
+        NOT_WRITABLE: "NotWritable",
+        OUT_OF_SPACE: "OutOfSpace",
+        TOO_MANY_ENTRIES: "TooManyEntries",
+        ALREADY_EXISTS: "AlreadyExists",
+        CONTENTS_MODIFIED: "ContentsModified",
+        ROOT_NOT_WATCHED: "RootNotBeingWatched",
+        EXCEEDS_MAX_FILE_SIZE: "ExceedsMaxFileSize",
+        NETWORK_DRIVE_NOT_SUPPORTED: "NetworkDriveNotSupported",
+        ENCODE_FILE_FAILED: "EncodeFileFailed",
+        DECODE_FILE_FAILED: "DecodeFileFailed",
+        UNSUPPORTED_UTF16_ENCODING: "UnsupportedUTF16Encoding"
  ```
+
diff --git a/src/filesystem/FileSystemError.js b/src/filesystem/FileSystemError.js
@@ -24,7 +24,6 @@
 define(function (require, exports, module) {
 
     /**
-     * @module FileSystemError FileSystemError
      *
      *
      * FileSystemError describes the errors that can occur when using the FileSystem, File,
@@ -33,6 +32,7 @@ define(function (require, exports, module) {
      * Error values are strings. Any "falsy" value: null, undefined or "" means "no error".
      *
      * Enumerated File System Errors
+     *
      * ```js
      *         UNKNOWN: "Unknown",
      *         INVALID_PARAMS: "InvalidParams",
@@ -52,6 +52,8 @@ define(function (require, exports, module) {
      *         DECODE_FILE_FAILED: "DecodeFileFailed",
      *         UNSUPPORTED_UTF16_ENCODING: "UnsupportedUTF16Encoding"
      *  ```
+     *
+     * @module FileSystemError
      */
     module.exports = {
         UNKNOWN: "Unknown",