search

bendytree / explainjs

A JavaScript library that creates a side-by-side view of your code with your explanations.
MIT License
247 stars 17 forks source link

JSDoc Support #2

Open ksafranski opened 11 years ago

ksafranski commented 11 years ago

This is a great tool for those of us that religiously comment our code. Would be awesome if it parsed JSDoc in some way, maybe just adding some basic formatting.

kadamwhite commented 11 years ago

I was just thinking the same thing—this would make the generated output from libraries like Angular much more useful.

bendytree commented 11 years ago

I added a patch (730e59b58bb3af7435e13009616536998d84a5aa) to break @something style comments onto new lines. I don't know much about JSDoc, so not sure what people are used to seeing. For now it's at least readable. Definitely open to suggestions.