Generate better API documentation

mozilla / pdf.js

PDF Reader in JavaScript

https://mozilla.github.io/pdf.js/

Apache License 2.0

48.63k stars 10k forks source link

Generate better API documentation #6526

Open brendandahl opened 9 years ago

brendandahl commented 9 years ago

The api docs at https://mozilla.github.io/pdf.js/api/draft/ are really bad. We have a lot of good information in api.js and in other files but it doesn't seem to be parsed correctly. Things we should look into:

[x] fixing the docs in the js file so they are more compatible with jsdoc
[ ] add some more examples within the docs
[ ] document the viewer api
[ ] update the theme so it includes our gh-pages header/footer

If anyone is willing to look into this, I'm happy to mentor and/or quickly review pull requests.

ManasJayanth commented 9 years ago

@brendandahl I'd like to take this up. What would be a good way to start? Fix comments first?

brendandahl commented 9 years ago

Yeah, there are a number of comments that aren't showing up in the generated documentation.

ManasJayanth commented 9 years ago

@brendandahl PR 6599 fixes missing comments.

Go ahead with adding examples?

mennucc commented 1 year ago

also, the examples in https://mozilla.github.io/pdf.js/examples/ do not work:

they refer to PDFJS whereas it is now called pdfjsLib
it refers to compatibility.js which does not exist
renderTask.then(function () ... fails