It DOES do all the function header and parameter parsing. It gives a
series of HTML pages that are all nicely cross-linked, decently styled
and perfect for the (already static) dev doc site.
Frankly I am with Felix on this one. You think it won't be that much
effort to add it to TW, and maybe with what Jeremy was pointing at,
that's true. But I was looking at the project as "Let's get this stuff
documented to help people (like me) bleeding through trying to
understand how all the code fits together NOW," and not another feature
to add to TW (isn't there a moratorium? :)
To me, the thing worth investing time in was actually adding the
documentation comments to the code (which doesn't affect the code in
ways that needs extensive testing) to then get the documentation
generated and PUBLISHED quickly. I could get behind volunteering to
write some of that documentation (because doing so would help me
solidify my understanding of the codebase as a whole). I wasn't looking
for yet another coding project, which the TW approach would entail, so
am not that interested in volunteering for that. Finite amount of time,
different priorities and all that.
The TW approach may be more "TW-pure," and more power to whoever
implements it.
On 2/5/2015 9:47 AM, Tobias Beer wrote:
I think what you're missing is the jsdoc parser (and node
integration) is already written, and in fact has been long
written, and stable.
Ok, so what does it return? Is that usable for us? We still want to
turn it into tiddlers, at least I sure do. I don't want some pdf or
HTML of which YUIDOC thinks its perfect. I believe, we also want that
function head parsed, not just the comments. Does it do all that in a
way that we can, say, handle some big JSON output and generate the
tiddlers from it?
Here's that draft I said I'd make...
https://github.com/tobibeer/TiddlyWikiDoc
Best wishes, Tobias.
--
You received this message because you are subscribed to a topic in the
Google Groups "TiddlyWikiDev" group.
To unsubscribe from this topic, visit
https://groups.google.com/d/topic/tiddlywikidev/VE4eVzoaReQ/unsubscribe.
To unsubscribe from this group and all its topics, send an email to
[email protected]
<mailto:[email protected]>.
To post to this group, send email to [email protected]
<mailto:[email protected]>.
Visit this group at http://groups.google.com/group/tiddlywikidev.
For more options, visit https://groups.google.com/d/optout.
--
You received this message because you are subscribed to the Google Groups
"TiddlyWikiDev" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/tiddlywikidev.
For more options, visit https://groups.google.com/d/optout.
