Skip to content

Commit 4e149bb

Browse files
committed
Remove @ from all nav ids. Avoids link rewriter.
1 parent 3e600b8 commit 4e149bb

1 file changed

Lines changed: 28 additions & 28 deletions

File tree

contributor_docs/contributing_to_the_p5js_reference.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ If you like, you can find the source code for this `sin` function in the p5 repo
175175

176176
Now we'll look at each section in turn.
177177

178-
### <a id="@description"></a>Describing the function
178+
### <a id="description"></a>Describing the function
179179

180180
Example:
181181

@@ -336,15 +336,15 @@ Here's a cut-down example from the source of [`applyMatrix`](https://github.com/
336336
* ...
337337
```
338338
339-
### <a id="@method"></a>`@method` - specifying the function name
339+
### <a id="method"></a>`@method` - specifying the function name
340340
341341
[`@method`](https://jsdoc.app/tags-function) is used to define the name of the function, in this case `sin`. Note that the function name does not include the brackets `()`.
342342
343343
You may sometimes see this missing from the reference. In that case JSDoc will try to infer it by looking at the name of the function from the following source code. It is recommended to include the function name using the @method tag where possible.
344344
345345
This tag is also useful when detailing multiple signatures for a function (see later).
346346
347-
### <a id="@param"></a>`@param` - specifying details of each parameter
347+
### <a id="param"></a>`@param` - specifying details of each parameter
348348
349349
[`@param`](https://jsdoc.app/tags-param) is used to define the parameters or arguments that the function accepts. It is used once per parameter.
350350
@@ -460,7 +460,7 @@ Example:
460460
* the current <a href="#/p5/angleMode">angleMode()</a>.
461461
```
462462

463-
### <a id="@return"></a>`@return` - specifying the return value
463+
### <a id="return"></a>`@return` - specifying the return value
464464

465465
[`@return`](https://jsdoc.app/tags-returns) is used to define the return value of the function.
466466

@@ -868,7 +868,7 @@ For more on `describe()` visit the [web accessibility contributor documentation]
868868

869869
With all the above you should have most of the tools needed to write and edit p5.js reference comments. However, there are a few more specialized usages of JSDoc reference comments that you may come across in p5.js. These are situationally useful and not something that you need often.
870870

871-
### <a id="@private"></a>`@private` tag
871+
### <a id="private"></a>`@private` tag
872872

873873
You can use the `@private` if a property or variable or class is private. If a feature is marked as `@private` it will not be included as part of the rendered reference on the website. This is done automatically for methods whose names start with `_`.
874874

@@ -892,7 +892,7 @@ invert(canvas) {
892892

893893
### `@module` and related tags
894894

895-
#### <a id="@module"></a>`@module` and `@submodule`
895+
#### <a id="module"></a>`@module` and `@submodule`
896896

897897
At the top of each source code file will be a comment block with a `@module` tag. A module is a top-level grouping of features in the reference pages on the website. This does _not_ necessarily correspond to any specific software `module` concept in the code itself.
898898

@@ -929,7 +929,7 @@ For both:
929929
*/
930930
```
931931

932-
#### <a id="@for"></a>The `@for` tag
932+
#### <a id="for"></a>The `@for` tag
933933

934934
The `@for` tag defines the relationship between this module and the overall `p5` class, effectively saying this module is a part of the `p5` class.
935935

@@ -961,7 +961,7 @@ Example of `@for` and `@requires`
961961
* @requires constants
962962
*/
963963
```
964-
#### <a id="@beta"></a>The @beta tag - marking experimental API features
964+
#### <a id="beta"></a>The @beta tag - marking experimental API features
965965

966966
This tag is used to mark that a feature is experimental and that its details may change or it may be removed. A warning will be presented explaining this on the reference page.
967967

@@ -983,7 +983,7 @@ It should be placed on a separate line in the comment block and does not need an
983983
*/
984984
```
985985

986-
#### <a id="@deprecated"></a>The @deprecated tag
986+
#### <a id="deprecated"></a>The @deprecated tag
987987

988988
Marks that a feature will be removed from a future version of p5.js, possibly also indicating a better option.
989989

@@ -1274,25 +1274,25 @@ getRow (r) {
12741274
12751275
Click on any tag to go to its section in the text.
12761276
1277-
| Tag | Usage | Notes |
1278-
|-------------------------------|----------------------------------|----------------------------------------------------|
1279-
| [@method](#@method) | @method name | Omitted in certain cases. |
1280-
| [@description](#@description) | @description text here | If omitted, uses first text before _any_ tag. |
1281-
| [@param](#@param) | @param \{type\} name Description | Name must match the function parameter. |
1282-
| [@return](#@return) | @return \{type\} Description | Omit type if it returns undefined. |
1283-
| [@example](#adding-examples) | @example Code on next lines... | Each gets `@example` before and a newline after. |
1284-
| [\`\`\`js example](#inserted-examples) | \`\`\`js example | Insert early examples _within_ the description. |
1285-
| [@chainable](#@chainable) | @chainable | Instead of `@return`, if it returns same object. |
1286-
| [@property](#property) | @property \{type\} name | Most p5 variables are properties of p5 class. |
1287-
| [@readonly](#readonly) | @readonly | Mark that a property is not writeable by the user. |
1288-
| [@static](#@static) | @static | Static method or property of a class. |
1289-
| [@for](#@for) | @for className | Associate a feature with a class. |
1290-
| [@module](#@module) | @module | Groups features for display. |
1291-
| [@submodule](#@module) | @submodule | Groups features for display. |
1292-
| [@class](#@class) | @class | Marks a class. |
1293-
| [@beta](#@beta) | @beta | Mark an experimental feature. |
1294-
| [@deprecated](#@deprecated) | @deprecated | A deprecated feature is intended to be removed. |
1295-
| [@private](#@private) | @private | Internal details not for publishing. |
1277+
| Tag | Usage | Notes |
1278+
|------------------------------|----------------------------------|----------------------------------------------------|
1279+
| [@method](#method) | @method name | Omitted in certain cases. |
1280+
| [@description](#description) | @description text here | If omitted, uses first text before _any_ tag. |
1281+
| [@param](#param) | @param \{type\} name Description | Name must match the function parameter. |
1282+
| [@return](#return) | @return \{type\} Description | Omit type if it returns undefined. |
1283+
| [@example](#adding-examples) | @example Code on next lines... | Each gets `@example` before and a newline after. |
1284+
| [\`\`\`js example](#inserted-examples) | \`\`\`js example | Insert early examples _within_ the description. |
1285+
| [@chainable](#chainable) | @chainable | Instead of `@return`, if it returns same object. |
1286+
| [@property](#property) | @property \{type\} name | Most p5 variables are properties of p5 class. |
1287+
| [@readonly](#readonly) | @readonly | Mark that a property is not writeable by the user. |
1288+
| [@static](#static) | @static | Static method or property of a class. |
1289+
| [@for](#for) | @for className | Associate a feature with a class. |
1290+
| [@module](#module) | @module | Groups features for display. |
1291+
| [@submodule](#module) | @submodule | Groups features for display. |
1292+
| [@class](#class) | @class | Marks a class. |
1293+
| [@beta](#beta) | @beta | Mark an experimental feature. |
1294+
| [@deprecated](#deprecated) | @deprecated | A deprecated feature is intended to be removed. |
1295+
| [@private](#private) | @private | Internal details not for publishing. |
12961296
12971297
12981298
## <a id="doc-differences-v1-to-v2"></a>Appendix: Summary of documentation differences between p5.js v1 and v2

0 commit comments

Comments
 (0)