Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

JavaScript-Doc generation #3

Open
odoodo opened this issue Sep 23, 2024 · 0 comments
Open

JavaScript-Doc generation #3

odoodo opened this issue Sep 23, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@odoodo
Copy link
Owner

odoodo commented Sep 23, 2024

Context
Functions and code templates can be prefixed w/ a JavaScriptDoc Header (quite similar to JavaDoc). This header is shown when hovering over the function name in Mirth Administrator. further, there is the possiblity to document channels in the Summary/Channel Description box. HTML can be used w/i the JavaScript doc part.

Goal
Currently, there is no (known) possibility to generate JavaScript-HTML like it can be done for Java packages. Thus support for JavaScriptDoc generation should be added.

Needed Actions
All relevant information are already generated by the Mirth Migrator library (and shown in Mirth Migrator). This information has to be accumulated to linked HTML pages.

For channels:

  • Channel name
  • Channel id (intern/extern)
  • Channel version & changed date
  • Channel descriptions
  • Channel group name & id (?)
  • Referenced code template libraries
  • Directly and indirectly used functions (as links)
  • Interfaces to external applications [This is HRS only, not applicable for general audience]
  • Change history (?) [This is HRS only, most probably not required by general audience]
  • Referenced external resources

For functions/code templates:

  • Function name
  • Code template Name
  • Type (code template/function)
  • Code template library (to which the code template belongs)
  • Description
  • Parameter description
  • Return value
  • Version & changed date
  • ID
  • Referencing channels (as links)
  • Referencing code templates (as links)
  • Directly and indirectly used functions (as links)
  • Scope (As shown under Channels/Edit Code Templates/Context in Mirth Administrator)

(cursive items are only valid for functions)

@odoodo odoodo added documentation Improvements or additions to documentation enhancement New feature or request labels Sep 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant