Add docfy for addon components (#27188)

* move script to scripts folder

* add docfy to router and scripts

* add docfy to router and scripts

* fix jsdoc syntax

* add component markdown files to gitignore

* improve error handling for scripts

* tidy up remaining jsdoc syntax

* add sample jsdoc components

* add known issue info

* make not using multi-line components clearer

* make generating docs clearer

* update copy

* final how to docfy cleanup

* fix ts file @module syntax

* fix read more syntax

* make docfy typescript compatible
This commit is contained in:
claire bontempo
2024-05-29 14:06:38 -07:00
committed by GitHub
parent fab2899508
commit e61bd967e3
70 changed files with 2932 additions and 512 deletions

View File

@@ -14,17 +14,12 @@ import { buildWaiter } from '@ember/test-waiters';
* that changes the input into a textarea
*
* @example
* <TextFile
* @uploadOnly={{true}}
* @helpText="help text"
* @onChange={{this.handleChange}}
* @label="PEM Bundle"
* />
* <TextFile @uploadOnly={{true}} @helpText="help text" @onChange={{this.handleChange}} @label="PEM Bundle" />
*
* @param {function} onChange - Callback function to call when the value of the input changes, returns an object in the shape of { value: fileContents, filename: 'some-file.txt' }
* @param {bool} [uploadOnly=false] - When true, renders a static file upload input and removes the option to toggle and input plain text
* @param {string} [helpText] - Text underneath label.
* @param {string} [label='File'] - Text to use as the label for the file input. If none, default of 'File' is rendered
* @param {string} [label=File] - Text to use as the label for the file input. If none, default of 'File' is rendered
*/
const waiter = buildWaiter('text-file');