https://github.com/bencoveney/ts-function-docs

https://github.com/bencoveney/ts-function-docs

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/bencoveney/ts-function-docs
• Owner: bencoveney
• License: mit
• Created: 2017-11-29T20:22:10.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-04-05T11:44:29.000Z (about 7 years ago)
• Last Synced: 2025-01-13T21:25:18.926Z (3 months ago)
• Language: TypeScript
• Size: 108 KB
• Stars: 1
• Watchers: 4
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ts-function-docs

Experimenting with generating documentation using the TypeScript compiler.

Look at `/input` and `/output` for examples.

Currently documents classes, their methods and parameters. Only methods with the `@docGenerate` method decorator have the documentation generated.

Parameters with the `@docIgnore` parameter decorator are excluded.