Comments (3)
This is exactly what autodoc does, if you're interested (major work-in-progress). It uses esprima with the comment
option set to include comments along with the AST. It then attempts to associate each comment with a node of the AST, and parses those with doctrine.
There's a lot of potential there, but it's messy in places. I'm still actively working on it. If you're interested in contributing, let me know; otherwise, if you want to tackle the problem your own way, that should give you a decent idea where to start.
from doctrine.
Cool, I'll check it out. I ended up doing the same actually.
https://github.com/videojs/doc-generator
I got far enough to generate the video.js API docs with relatively few jsdoc tags.
https://github.com/videojs/video.js/blob/v4.4.0/docs/api/vjs.Player.md
...came from...
https://github.com/videojs/video.js/blob/v4.4.0/src/js/player.js
Some of the tags left can actually be removed now, like param tags I think. It's been a few months since I've touched it.
I never got it to work with nested scopes though, at least not without using tags, so it may not be super useful outside of video.js land.
from doctrine.
Cool, good discussion here!
I also maintain a list of documentation generators, and would point to esdoc, typedoc, and documentation.js as major entrants in the 'inference assisted documentation' space.
Closing this issue to keep Issues focused on actionable tasks, but feel free to continue discussing!
from doctrine.
Related Issues (20)
- Support type intersections HOT 9
- What's the reason for the dot in stringifing TypeExpression (Array.<string>)? HOT 3
- Add support for @property without type HOT 2
- Mechanism for 'escaping' @ symbol when part of an example (i.e. Decorators) HOT 5
- Option for allowing multiple tags per line. HOT 1
- Permitting numeric keys in parameter names
- TypeError: Cannot read property 'replace' of undefined HOT 1
- fails to read @name tags with slashes HOT 1
- Using `unwrap` to parse Block comment without `*` separators breaks indentation. HOT 5
- Union type stringification does not respect compact flag
- Support for relative type references HOT 3
- @example warp the decorator does NOT work HOT 3
- The type is in 'name' when there is no name HOT 1
- Record type range gets offset after linebreaks HOT 1
- Support `@access package` HOT 1
- Support for TypeScript import types HOT 1
- doctrine not parsing @Param with default value HOT 1
- Avoid erring with "event:" within `@param` and `@returns` tags and any other allowed contexts HOT 1
- Allow for missing `@param`'s or `@return(s)` with `@implements` on the block; also possibly for @augments/@extends and @override HOT 1
- Archive this repository HOT 5
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from doctrine.