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

Add PHPdoc class documentation to docs.nextcloud.com #509

Closed
juliusknorr opened this issue Jun 21, 2017 · 5 comments
Closed

Add PHPdoc class documentation to docs.nextcloud.com #509

juliusknorr opened this issue Jun 21, 2017 · 5 comments

Comments

@juliusknorr
Copy link
Member

It is still linking to the other project, i guess we should have an up to date version of the phpdoc class documentation for Nextcloud.

See: Nextcloud App API
https://docs.nextcloud.com/server/12/developer_manual/app/index.html#phpdoc-class-documentation

@juliusknorr
Copy link
Member Author

maybe @MorrisJobke ?

@MorrisJobke
Copy link
Member

Mmmmh ... any good PHPDoc documentation generator? Because I really don't like the default one, because it's not very easy to read :/

But then I'm open do add a cron job that updates this.

@juliusknorr
Copy link
Member Author

https://github.com/ApiGen/ApiGen looks promising, but I was not running out of the box with the Nextcloud code base when I gave it a short try.

I'll check if i find anything else.

@juliusknorr
Copy link
Member Author

@BernhardPosselt mentioned https://github.com/varspool/sphpdox which would allow us to include to API documentation to the sphinx built developer documentation. Sadly it is not maintained, as it seems in the repo. Documentation builds fine except for one error with the following line: https://github.com/nextcloud/server/blob/5f25dd7095fadccb7458dbe09c048fbf6645552d/lib/public/IPreview.php#L49

Other options i still need to check out:

Maybe we can also use PHPdoc (https://www.phpdoc.org) as before and look for a different template that makes it a bit nicer to read.

@juliusknorr
Copy link
Member Author

Implemented with #578

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

No branches or pull requests

2 participants