search

cqframework / vscode-cql

VS Code Clinical Quality Language Extension
Apache License 2.0
9 stars 5 forks source link

Typedocs #77

Open jreyno77 opened 2 months ago

jreyno77 commented 2 months ago

Added type docs and documentation for: buildParameters normalizeCqlExecution executeCql ConnectionManager

Can run npx typedoc --out docs --entryPointStrategy expand src/ to view generated files

I focused not only on adding documentation for what I thought was the most important pieces of the extension, but I also focused on providing the most necessary information as visually as I could so that as a developer one could simple highlight the Class, or method and get all the information they need at a simple glance. There is additional information as well, but that is better viewed in the documentation pages generated. I tried to keep the most valuable information within the hover window.

jreyno77 commented 2 months ago

Should I make the doc generation part of the vscode:prepublish step or the compile step?