search

mpdf / mpdf.github.io

mPDF documentation
https://mpdf.github.io
Other
509 stars 160 forks source link

Using phpdoc #57

Open machour opened 6 years ago

machour commented 6 years ago

Browsing through mpdf source code, I noticed several inline comments mentioning versions where a particular change occurred. Some examples:

if (!empty($attr['POSITION'])) {  // mPDF 5.7.2

I also noticed that the documentation is maintained by hand, and that some of the latest changes in mPDF are not yet reflected (which is completely understandable).

I was wondering if phpdoc could be used more efficiently in the source code, in order to generate the documentation. I know this will require a lot of work, and I'm willing to participate here as well :)

Let me know what are your thoughts on this subject.

danielhjames commented 6 years ago

Hi @machour , generated documentation would be an excellent project, as the existing static documentation is under a restrictive licence and cannot be updated without permission from the author, a permission we do not have. See https://github.com/mpdf/mpdf.github.io/blob/development/copyright.md