github/svgedit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(jsdoc): link/naming fixes

Browse Source
This commit is contained in:
Brett Zamir
2020-05-06 12:14:02 +08:00
parent 381a0d9460
commit 171e1ce856
4 changed files with 49 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/tutorials/EditorAPI.md
View File

@@ -4,8 +4,8 @@ This is an entry point that summarizes the documentation on the Editor.
For user-facing information about the Editor, see [Editor]{@tutorial Editor}.
The main API entrance point is with the [Editor JSDocs]{@link module:Editor}.
The main API entrance point is with the [Editor JSDocs]{@link module:SVGEditor}.
## Canvas-specific methods
See [Canvas]{@tutorial Canvas}.
See [Canvas]{@tutorial CanvasAPI}.

6
docs/tutorials/Events.md
View File

@@ -46,17 +46,17 @@ $(document).bind('svgEditorReady', function () {
```
If you are acting within the frame, you may use `svgEditor.ready`
(see [Within-frame events](#Editor-within-frame-events-svgEditor) below).
(see "Editor (within-frame) events (`svgEditor`)" below).
## Editor (within-frame) events (`svgEditor`)
### `svgEditor.canvas`
- Canvas object. See [Canvas events](#Canvas-events).
- Canvas object. See "Canvas events".
### `svgEditor.canvas.bind(eventName, function () {})`
- Method for listening to canvas events. See [Canvas events](#Canvas-events).
- Method for listening to canvas events. See "Canvas events".
### `svgEditor.ready(function () {})`

4
docs/tutorials/FrequentlyAskedQuestions.md
View File

@@ -19,11 +19,11 @@ under `editor/extensions/`.
**Q: How can I serve SVG graphic editor from my own server?**
A: You need to download the latest version to your server and unzip.
The exact commands/instructions are here: <http://howik.com/Improve_your_user%27s_experience_by_adding_svg_graphic_editor_to_your_website_in_less_than_2_minutes>
The exact commands/instructions are here: {@link https://visihow.com/Improve_your_user's_experience_by_adding_svg_graphic_editor_to_your_website_in_less_than_2_minutes}
**Q: How can I help?**
A: See [Testing]{@tutorial Testing} and [ReleaseInstructions]{@tutorial ReleaseInstructions}
A: See [Testing](../Testing.md) and [ReleaseInstructions](../ReleaseInstructions.md).
<!-- The remaining should be moved to Editor.md as documentation,
assuming they are still valid -->