Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Using phpdoc #57

Open
machour opened this issue Nov 20, 2017 · 1 comment
Open

Using phpdoc #57

machour opened this issue Nov 20, 2017 · 1 comment

Comments

@machour
Copy link

machour commented Nov 20, 2017

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
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants