kitbagjs / router

A type safe router for vuejs
MIT License
131 stars 1 forks source link

Typedoc with jsdocs #165

Closed stackoverfloweth closed 1 month ago

stackoverfloweth commented 1 month ago

Primary objective, add API docs for components, composables, errors, functions, interfaces, and types.

80% generated with jsdocs with some small tweaks. Added script for re-generating files, though as I mentioned there was a not insignificant amount of hand crafting to improve generated docs.

Also adds RouteProps type in bundle, adds jsdoc strings to RouteProps and ResolvedRoute.

netlify[bot] commented 1 month ago

Deploy Preview for kitbag-router ready!

Name Link
Latest commit 2f4000807ac984f3c4c76af2bbd24c413a4a419b
Latest deploy log https://app.netlify.com/sites/kitbag-router/deploys/663d8fa6454df400085e8455
Deploy Preview https://deploy-preview-165--kitbag-router.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.