Sorry to be late jumping into this thread. I have a couple of thoughts:
* having observed other projects, the most robust way of producing API documentation is to use tooling to extract the documentation from the source code. In our case, we'd extract it into a TiddlyWiki that can add a decent searchable UI over the top. That's why I've generally tried to use TW wiki text in the comments above functions in the core (or at least those that have a comment!). It looks like you're doing something like that, I recognise the main wiki.js docs * to permit hyperlinking the docs better, I'd be interested in exploring splitting the core source files into individual tiddlers for each function. I'd want to explore the performance and usability implications of so many more shadow tiddlers, and so many separate files when using an ordinary text editor to browse the source > Jeremy's viewpoint is, that there is enough "inline" documentation in the > code already. ... That's probably true -- for him :) That's not quite right, I absolutely acknowledge that the inline docs are inadequate at the moment. > So we can't expect him to add more. That's ok. It should be a community > effort to add and extract what new contributors need. TW has the possibility > built in, to extract javascript comments and transfer them into readable html > pages or even TWs. ... I'd certainly appreciate help with filling out the code comments. Best wishes Jeremy -- Jeremy Ruston [email protected] http://jermolene.com > On 6 Jun 2016, at 09:34, Jed Carty <[email protected]> wrote: > > Only functions in wiki.js are in it so far. That is why I am asking for help. > -- > You received this message because you are subscribed to the Google Groups > "TiddlyWiki" 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 https://groups.google.com/group/tiddlywiki. > To view this discussion on the web visit > https://groups.google.com/d/msgid/tiddlywiki/d521f241-f69c-49c5-8687-82971cc50b7b%40googlegroups.com. > For more options, visit https://groups.google.com/d/optout. -- You received this message because you are subscribed to the Google Groups "TiddlyWiki" 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 https://groups.google.com/group/tiddlywiki. To view this discussion on the web visit https://groups.google.com/d/msgid/tiddlywiki/B4CEF312-7700-479F-9FE7-6770A2041A0C%40gmail.com. For more options, visit https://groups.google.com/d/optout.
