Write improved user-friendly documentation for Hypo.

aabtop / reify

Reify lets you embed a customized TypeScript runtime within a C++ application.

MIT License

6 stars 0 forks source link

Write improved user-friendly documentation for Hypo. #27

Closed aabtop closed 3 years ago

aabtop commented 4 years ago

This includes:

Providing comments for Reify types (issue #26).
Document command line switches and parameters in README.md file and usage text, especially --make_workspace_dir.
Add comments to reify.h.

aabtop commented 4 years ago

Perhaps also talk about the vs code playground_workspace/ folder which contains all the example code?

aabtop commented 4 years ago

The --make_workspace_dir is much easier to understand now with 045eb8f359e38893fe2987ff2e089060ec9e4335, where it was made in to a subcommand, and also documented properly.

We now produce comments in Reify-generated code, but unfortunately, we generate the ".d.ts" file from the TypeScript Compiler, which does not carry the comments over, so either we need to generate the ".d.ts" file directly to get the comments, or find a way to setup the TSC to carry them through.