Skip to content

Commit 0eb7adf

Browse files
committed
tag quick reference, clarify examples are multiline
1 parent 3b2733a commit 0eb7adf

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

contributor_docs/contributing_to_the_p5js_reference.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1309,16 +1309,16 @@ Click on any tag to go to its section in the text.
13091309
| [@description](#description) | @description text here | If omitted, uses first text before _any_ tag. |
13101310
| [@param](#param) | @param \{type\} name Description | Name must match the function parameter. |
13111311
| [@return](#return) | @return \{type\} Description | Omit type if it returns undefined. |
1312-
| [@example](#adding-examples) | @example Code on next lines... | Each gets `@example` before and a newline after. |
1313-
| [\`\`\`js example](#inserted-examples) | \`\`\`js example | Insert early examples _within_ the description. |
1314-
| [@chainable](#chaining) | @chainable | Instead of `@return`, if it returns same object. |
1312+
| [@example](#adding-examples) | @example <br/>//.. example code | Each gets `@example` before and a newline after. |
1313+
| [\`\`\`js example](#inserted-examples) | \`\`\`js example<br/>//...<br/>\`\`\` | Insert early examples _within_ the description. |
13151314
| [@property](#property) | @property \{type\} name | Most p5 variables are properties of p5 class. |
13161315
| [@readonly](#readonly) | @readonly | Mark that a property is not writeable by the user. |
13171316
| [@static](#static) | @static | Static method or property of a class. |
1318-
| [@for](#for) | @for className | Associate a feature with a class. |
13191317
| [@module](#module) | @module | Groups features for display. |
13201318
| [@submodule](#module) | @submodule | Groups features for display. |
13211319
| [@class](#class) | @class | Marks a class. |
1320+
| [@for](#for) | @for className | Associate a feature with a class. |
1321+
| [@chainable](#chaining) | @chainable | Instead of `@return`, if it returns same object. |
13221322
| [@beta](#beta) | @beta | Mark an experimental feature. |
13231323
| [@deprecated](#deprecated) | @deprecated | A deprecated feature is intended to be removed. |
13241324
| [@private](#private) | @private | Internal details not for publishing. |

0 commit comments

Comments
 (0)