Skip to content

Commit 761aaee

Browse files
NileshArnaiyatmcw
andauthored
Update GETTING_STARTED.md (#1294)
* Update GETTING_STARTED.md * Update GETTING_STARTED.md * Update GETTING_STARTED.md Co-authored-by: Tom MacWright <[email protected]>
1 parent 7b82bcd commit 761aaee

File tree

1 file changed

+12
-13
lines changed

1 file changed

+12
-13
lines changed

docs/GETTING_STARTED.md

+12-13
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ On the second line:
6262
6363
* `@param` is **a tag**: This tag indicates that we'll be documenting a function's parameter.
6464
* `{number}` is **a type**. It says that the input to this function is
65-
a JavaScript "number". It could also say `{string}`,
65+
a JavaScript "number." It could also say `{string}`,
6666
`{Object}`, `{Date}`, or any other JavaScript built-in type. And if you
6767
defined a custom class, like `FooClass`, you can use it as a type, too! Just say `{FooClass}`.
6868
* `input` is the name of the input variable. It matches what the code
@@ -96,7 +96,7 @@ populates `@name`, `@kind`, and `@memberof` tags based on its reading of the
9696
code.
9797
9898
**Normalization**: JSDoc has multiple words for the same thing: you can
99-
say `@augments` or `@extends` and they'll do the same thing.
99+
say `@augments` or `@extends`, and they'll do the same thing.
100100
101101
## Development Process
102102
@@ -108,17 +108,16 @@ automated style check.
108108
## The Tags
109109
110110
[**`jsdoc.app`**](https://jsdoc.app/) covers all available tags in the
111-
JSDoc syntax, and is a great reference.
112-
113-
The most commonly used tags are:
114-
115-
* `@param` - input given to a function as an argument
116-
* `@returns` - output value of a function
117-
* `@name` - explicitly set the documented name of a function, class, or variable
118-
* `@private` - you can use `@private` to document
119-
code and not have it included in the generated documentation;
120-
maybe it's not part of the public API. There's also `@public` and `@protected`
121-
* `@example` - you can use the `@example` tag to add inline code examples with your
111+
JSDoc syntax, and is a great reference. The most commonly used tags
112+
are:
113+
114+
* @param - input is given to a function as an argument
115+
* @returns - output value of a function
116+
* @name - explicitly set the documented name of a function, class, or variable
117+
* @private - you can use @private to document
118+
code and not have it included in the generated documentation,
119+
maybe it's not part of the public API. There's also @public and @protected
120+
* @example - you can use the @example tag to add inline code examples with your
122121
documentation
123122
124123
If your text editor does not highlight JSDoc tags,

0 commit comments

Comments
 (0)