jf-roku/docs/api-docs-readme.md
Charles Ewert 00a6858c22
Auto update api docs and upload api docs to gh-pages (#1418)
Co-authored-by: cewert <cewert@users.noreply.github.com>
2023-10-26 22:19:51 -04:00

12 lines
523 B
Markdown

# Welcome
Use the `Modules` dropdown or the search feature to find files and functions to inspect
## Known Issues
- BrighterScript namespaces:
- Duplicate function names will prevent the entire file from being parsed by JSDoc i.e. having `namespace.red.Delete()` and `namespace.blue.Delete()`
- When viewing source files:
- The syntax highlighter doesn't support BrightScript and will treat all source files as JavaScript.
- The page scrolls to the correct line number but it does not highlight the selected line.