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

@@ -7,12 +7,10 @@ import Component from '@glimmer/component';
import { action } from '@ember/object';
/**
* @module JsonEditor
* @module InfoTooltip
*
* @example
* ```js
* <JsonEditor @title="Policy" @value={{codemirror.string}} @valueUpdated={{ action "codemirrorUpdate"}} />
* ```
* <InfoTooltip>Important info!</InfoTooltip>
*
* @param {string} [verticalPosition] - vertical position specification (above, below)
* @param {string} [horizontalPosition] - horizontal position specification (center, auto-right)