Skip to content

Commit 7fcacd6

Browse files
committed
docs: fix jsdoc issues with module tag
1 parent 5a7527a commit 7fcacd6

File tree

2 files changed

+24
-49
lines changed

2 files changed

+24
-49
lines changed

docs/API-Reference/filesystem/FileSystemError.md

Lines changed: 21 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -3,60 +3,33 @@
33
const FileSystemError = brackets.getModule("filesystem/FileSystemError")
44
```
55

6-
<a name="FileSystemError FileSystemError
7-
6+
<a name="module_FileSystemError"></a>
87

8+
## FileSystemError
99
FileSystemError describes the errors that can occur when using the FileSystem, File,
1010
and Directory modules.
1111

12-
Error values are strings. Any falsy value_ null, undefined or means no error.
12+
Error values are strings. Any "falsy" value: null, undefined or "" means "no error".
1313

1414
Enumerated File System Errors
15-
```js
16-
UNKNOWN_ Unknown,
17-
INVALID_PARAMS_ InvalidParams,
18-
NOT_FOUND_ NotFound,
19-
NOT_READABLE_ NotReadable,
20-
UNSUPPORTED_ENCODING_ UnsupportedEncoding,
21-
NOT_SUPPORTED_ NotSupported,
22-
NOT_WRITABLE_ NotWritable,
23-
OUT_OF_SPACE_ OutOfSpace,
24-
TOO_MANY_ENTRIES_ TooManyEntries,
25-
ALREADY_EXISTS_ AlreadyExists,
26-
CONTENTS_MODIFIED_ ContentsModified,
27-
ROOT_NOT_WATCHED_ RootNotBeingWatched,
28-
EXCEEDS_MAX_FILE_SIZE_ ExceedsMaxFileSize,
29-
NETWORK_DRIVE_NOT_SUPPORTED_ NetworkDriveNotSupported,
30-
ENCODE_FILE_FAILED_ EncodeFileFailed,
31-
DECODE_FILE_FAILED_ DecodeFileFailed,
32-
UNSUPPORTED_UTF16_ENCODING_ UnsupportedUTF16Encoding
33-
```module_"></a>
34-
35-
## FileSystemError FileSystemError
36-
37-
38-
FileSystemError describes the errors that can occur when using the FileSystem, File,
39-
and Directory modules.
40-
41-
Error values are strings. Any falsy value: null, undefined or means no error.
4215

43-
Enumerated File System Errors
4416
```js
45-
UNKNOWN: Unknown,
46-
INVALID\_PARAMS: InvalidParams,
47-
NOT\_FOUND: NotFound,
48-
NOT\_READABLE: NotReadable,
49-
UNSUPPORTED\_ENCODING: UnsupportedEncoding,
50-
NOT\_SUPPORTED: NotSupported,
51-
NOT\_WRITABLE: NotWritable,
52-
OUT\_OF\_SPACE: OutOfSpace,
53-
TOO\_MANY\_ENTRIES: TooManyEntries,
54-
ALREADY\_EXISTS: AlreadyExists,
55-
CONTENTS\_MODIFIED: ContentsModified,
56-
ROOT\_NOT\_WATCHED: RootNotBeingWatched,
57-
EXCEEDS\_MAX\_FILE\_SIZE: ExceedsMaxFileSize,
58-
NETWORK\_DRIVE\_NOT\_SUPPORTED: NetworkDriveNotSupported,
59-
ENCODE\_FILE\_FAILED: EncodeFileFailed,
60-
DECODE\_FILE\_FAILED: DecodeFileFailed,
61-
UNSUPPORTED\_UTF16\_ENCODING: UnsupportedUTF16Encoding
17+
UNKNOWN: "Unknown",
18+
INVALID_PARAMS: "InvalidParams",
19+
NOT_FOUND: "NotFound",
20+
NOT_READABLE: "NotReadable",
21+
UNSUPPORTED_ENCODING: "UnsupportedEncoding",
22+
NOT_SUPPORTED: "NotSupported",
23+
NOT_WRITABLE: "NotWritable",
24+
OUT_OF_SPACE: "OutOfSpace",
25+
TOO_MANY_ENTRIES: "TooManyEntries",
26+
ALREADY_EXISTS: "AlreadyExists",
27+
CONTENTS_MODIFIED: "ContentsModified",
28+
ROOT_NOT_WATCHED: "RootNotBeingWatched",
29+
EXCEEDS_MAX_FILE_SIZE: "ExceedsMaxFileSize",
30+
NETWORK_DRIVE_NOT_SUPPORTED: "NetworkDriveNotSupported",
31+
ENCODE_FILE_FAILED: "EncodeFileFailed",
32+
DECODE_FILE_FAILED: "DecodeFileFailed",
33+
UNSUPPORTED_UTF16_ENCODING: "UnsupportedUTF16Encoding"
6234
```
35+

src/filesystem/FileSystemError.js

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@
2424
define(function (require, exports, module) {
2525

2626
/**
27-
* @module FileSystemError FileSystemError
2827
*
2928
*
3029
* FileSystemError describes the errors that can occur when using the FileSystem, File,
@@ -33,6 +32,7 @@ define(function (require, exports, module) {
3332
* Error values are strings. Any "falsy" value: null, undefined or "" means "no error".
3433
*
3534
* Enumerated File System Errors
35+
*
3636
* ```js
3737
* UNKNOWN: "Unknown",
3838
* INVALID_PARAMS: "InvalidParams",
@@ -52,6 +52,8 @@ define(function (require, exports, module) {
5252
* DECODE_FILE_FAILED: "DecodeFileFailed",
5353
* UNSUPPORTED_UTF16_ENCODING: "UnsupportedUTF16Encoding"
5454
* ```
55+
*
56+
* @module FileSystemError
5557
*/
5658
module.exports = {
5759
UNKNOWN: "Unknown",

0 commit comments

Comments
 (0)