Generate better API documentation #6599
Conversation
|
|
||
| return PDFDocumentLoadingTask; | ||
| })(); |
There was a problem hiding this comment.
Unneeded code change -- please revert tabulation back.
|
Nice! Can you also fix double entry of PDFDocumentLoadingTask (see http://107.22.172.223:8877/824a96518b07a1c/api/draft/PDFDocumentLoadingTask.html)? Interesting that PDFDocumentProxy (see http://107.22.172.223:8877/824a96518b07a1c/api/draft/PDFDocumentProxy.html) has no such issue. |
|
I agree, this is looking much better now! Fortunately the update to JSDoc 3.3.3 also included a better lay-out, so it is more pleasant to look at too. |
|
@timvandermeij Update JSDoc for PDFJS too? |
|
No, we already use JCDoc 3.3.3 as can be seen on the last text line of http://107.22.172.223:8877/824a96518b07a1c/api/draft/PDFDocumentLoadingTask.html. I just meant to say that the general look of the documentation has improved with that update from recently. No need to do any updates, sorry for the confusion :) |
|
@timvandermeij Oh! I thought you were referring to the version in package.json which is 3.3.0-alpha9 Thank you :) Anyways, about adding more examples within the docs, how do I get started? |
| */ | ||
| var PDFDocumentLoadingTask = (function PDFDocumentLoadingTaskClosure() { | ||
| /** @constructs PDFDocumentLoadingTask */ |
There was a problem hiding this comment.
Can you remove other @constructs in this file too?
|
Back to how it was before along with the fix |
|
/botio-linux preview |
From: Bot.io (Linux)ReceivedCommand cmd_preview from @timvandermeij received. Current queue size: 0 Live output at: http://107.21.233.14:8877/c13b9829bfbe380/output.txt |
From: Bot.io (Linux)SuccessFull output at http://107.21.233.14:8877/c13b9829bfbe380/output.txt Total script time: 0.80 mins Published |
|
Looks good. Thank you for the patch. |
…-docs Generate better API documentation
/cc @yurydelendik @brendandahl
Initiating a thread discussing ways to improving the docs and feedback for the same.
Starting with missing comments on the API docs page
/re #6526