search

helpers / template-helper-apidocs

Template helper for automatically generating API docs from code comments. This is based on helper-apidocs, but specifically for applications built-with the Template library.
MIT License
5 stars 1 forks source link

Why template-helper-apidocs #2

Closed stefanwalther closed 8 years ago

stefanwalther commented 8 years ago

Hi @jonschlinkert,

just being curious. Why did you chose to write your own implementation and e.g. not using jsdoc and https://www.npmjs.com/package/jsdoc-to-markdown?

Regards Stefan

jonschlinkert commented 8 years ago

well, good question. this is the first I've heard of the project you linked to, it looks really nice, I'll probably spend some time reviewing it to see if it might work for our needs.

the main reason I decide to create the apidocs stuff was for an idea I had that I still haven't had time to complete, and I really love programming lol. that said, ironically I actually worked on it over the past couple of days and got about 80% of the way there... for the longest time I've wanted to be able to do things like get, set and extend code comments as easily as you can any other javascript object. I also want to be able to lint, update and format code comments via API. not sure if this all makes sense, but I'm excited about the idea of doing it lol.

anyway, this was my motivation for creating snapdragon too, but that project needs some tweaking before it's usable enough to work for this use case.

does that help?

stefanwalther commented 8 years ago

Thx for the long answer, sounds interesting. Continue great work. (Closing this, since this wasn't really an issue).