22 Jul 2012 23:39
Doc parser & API viewer questions / feedback
Mark Wubben <mark <at> novemberborn.net>
2012-07-22 21:39:27 GMT
2012-07-22 21:39:27 GMT
Some questions and general feedback about the doc parser, as I was trying to get the API docs for dojo/promise come out as nicely as possible. Documentation generated according to the instructions at <https://github.com/wkeese/api-viewer/>. Here I'm trying to define the `promise` property of Deferred: <https://github.com/novemberborn/dojo/compare/docs#L0L94>. My comments are never included in the documentation. If I define the property elsewhere, say within a block like this, they are included: /*===== lang.extend(Deferred, { // promise: // … promise: null }); =====*/ The assignment to `var reject` here causes `instance` to be one of the return values: <https://github.com/novemberborn/dojo/compare/docs#L0L179>, even though I've declared the return value. Return statements like these don't get picked up correctly: <https://github.com/novemberborn/dojo/compare/docs#L0L112>. Adding `// Boolean` at the end doesn't work. Perhaps given the triple equals the boolean could even be deduced. I'd like to be able to link to other pages, e.g. by including [dojo/errors/CancelError] in the documents. I've done this in another project that uses Marked. Is this already included somewhere but with different syntax? If not, where could I include it? In fact, which repo is the actual one that's being used? <https://github.com/wkeese/api-viewer/> says to use <https://github.com/wkeese/js-doc-parse/tree/all-my-changes>. trace() takes zero or more arguments, of any type. Can this be expressed? <https://github.com/novemberborn/dojo/compare/docs#L6L32>(Continue reading)
RSS Feed