Let's improve the JavaDoc in OpenPDF! This will make it easier to learn how to use the library. Please help add good descriptions to the source code in a consistent way. Pull requests welcome!
The most recent JavaDoc can be found here: https://librepdf.github.io/OpenPDF/docs-1-3-17/
andreasrosdal
All 8 comments
Let's improve the JavaDoc in OpenPDF! This will make it easier to learn how to use the library. Please help add good descriptions to the source code in a consistent way. Pull requests welcome!
This seems like a giant task
I mean, last I check there were ~66 errors and ~4k warnings.
Fixing errors is relatively easy, warnings also, to some extent, but then there are ~90% cases where parameter's description is missing. for the sake of removing warning, I suppose, we can provide a decent description, but not always.
I am willing to take it up as long but apt description, I'm afraid, will not be possible (unless one knows ins and outs of the class/method).
What's your opinion?
vic0075
on 4 May 2020
I suggest starting with the most important things. Fixing the errors. Then making sure the most important classes are well documented.
andreasrosdal
on 4 May 2020
andreasrosdal
on 10 May 2020
The most recent JavaDoc can be found here: https://librepdf.github.io/OpenPDF/docs-1-3-17/
andreasrosdal
on 13 May 2020
Hi ! Do you still need help with that ? I'd love to contribute !
laurerunser
on 2 Oct 2020
Hi ! Do you still need help with that ? I'd love to contribute !
Yes, please. Pull requests welcome!
asturio
on 3 Oct 2020
Should this be closed now? JavaDoc can always be improved and corrected.
asturio
on 6 Oct 2020
Maybe keep it open some more. I might be able to work on all those errors by the end of the week !
laurerunser
on 6 Oct 2020
Related issues
literakl
路
6Comments
razilein
路
6Comments
sjalouali
路
3Comments
sabraMa
路
5Comments
erikliberal
路
7Comments
Most helpful comment
Maybe keep it open some more. I might be able to work on all those errors by the end of the week !