From 279eabeb7d5506810d77447b561ea35aa5f19fb1 Mon Sep 17 00:00:00 2001 From: Rich Rein Date: Mon, 5 Jun 2023 09:16:46 -0500 Subject: [PATCH 1/3] Update JSDoc site url (usejsdoc.org -> jsdoc.app) --- docs/Documenting.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/Documenting.md b/docs/Documenting.md index d756a39e3..a333afd60 100644 --- a/docs/Documenting.md +++ b/docs/Documenting.md @@ -109,7 +109,7 @@ export default class Button extends React.Component { ## Public methods -By default, any methods your components have are considered to be private and are not published. Mark your public methods with JSDoc [`@public`](http://usejsdoc.org/tags-public.html) tag to get them published in the docs: +By default, any methods your components have are considered to be private and are not published. Mark your public methods with JSDoc [`@public`](https://jsdoc.app/tags-public.html) tag to get them published in the docs: ```javascript /** @@ -125,7 +125,7 @@ insertAtCursor(text) { ## Ignoring props -By default, all props your components have are considered to be public and are published. In some rare cases, you might want to remove a prop from the documentation while keeping it in the code. To do so, mark the prop with JSDoc [`@ignore`](http://usejsdoc.org/tags-ignore.html) tag to remove it from the docs: +By default, all props your components have are considered to be public and are published. In some rare cases, you might want to remove a prop from the documentation while keeping it in the code. To do so, mark the prop with JSDoc [`@ignore`](https://jsdoc.app/tags-ignore.html) tag to remove it from the docs: ```javascript MyComponent.propTypes = { @@ -155,17 +155,17 @@ The component will be displayed with a custom β€œThe Best Button Ever πŸ™β€ na ## Using JSDoc tags -You can use the following [JSDoc](http://usejsdoc.org/) tags when documenting components, props and methods: +You can use the following [JSDoc](https://jsdoc.app/) tags when documenting components, props and methods: -- [@deprecated](http://usejsdoc.org/tags-deprecated.html) -- [@see, @link](http://usejsdoc.org/tags-see.html) -- [@author](http://usejsdoc.org/tags-author.html) -- [@since](http://usejsdoc.org/tags-since.html) -- [@version](http://usejsdoc.org/tags-version.html) +- [@deprecated](https://jsdoc.app/tags-deprecated.html) +- [@see, @link](https://jsdoc.app/tags-see.html) +- [@author](https://jsdoc.app/tags-author.html) +- [@since](https://jsdoc.app/tags-since.html) +- [@version](https://jsdoc.app/tags-version.html) When documenting props you can also use: -- [@param, @arg, @argument](http://usejsdoc.org/tags-param.html) +- [@param, @arg, @argument](https://jsdoc.app/tags-param.html) All tags can render Markdown. From e7c6af0e114099389afdffee355ab5b4622420e6 Mon Sep 17 00:00:00 2001 From: Rich Rein Date: Mon, 5 Jun 2023 09:17:57 -0500 Subject: [PATCH 2/3] Split apart JSDoc see and link --- docs/Documenting.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Documenting.md b/docs/Documenting.md index a333afd60..44e9cdecf 100644 --- a/docs/Documenting.md +++ b/docs/Documenting.md @@ -158,7 +158,7 @@ The component will be displayed with a custom β€œThe Best Button Ever πŸ™β€ na You can use the following [JSDoc](https://jsdoc.app/) tags when documenting components, props and methods: - [@deprecated](https://jsdoc.app/tags-deprecated.html) -- [@see, @link](https://jsdoc.app/tags-see.html) +- [@see](https://jsdoc.app/tags-see.html), [@link](https://jsdoc.app/tags-link.html), - [@author](https://jsdoc.app/tags-author.html) - [@since](https://jsdoc.app/tags-since.html) - [@version](https://jsdoc.app/tags-version.html) From 5d2069211de998cd2b6d33823965f1cd9b86dca3 Mon Sep 17 00:00:00 2001 From: Rich Rein Date: Fri, 4 Aug 2023 08:49:09 -0500 Subject: [PATCH 3/3] Update Configuration.md Clarify the default for the title --- docs/Configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Configuration.md b/docs/Configuration.md index 5e010348f..7e08fe1d2 100644 --- a/docs/Configuration.md +++ b/docs/Configuration.md @@ -610,7 +610,7 @@ See examples in the [cookbook](Cookbook.md#how-to-change-styles-of-a-style-guide ## `title` -Type: `String`, default: ` Style Guide` +Type: `String`, default: ` Style Guide` Style guide title.