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

Documentation should link API #6617

Closed
jkufner opened this issue Aug 11, 2017 · 3 comments
Closed

Documentation should link API #6617

jkufner opened this issue Aug 11, 2017 · 3 comments

Comments

@jkufner
Copy link

jkufner commented Aug 11, 2017

All mentions of classes and methods in the documentation should link to API documentation.

For example, at http://docs.doctrine-project.org/projects/doctrine-dbal/en/latest/reference/query-builder.html the Doctrine\DBAL\Connection#createQueryBuilder should link to http://www.doctrine-project.org/api/dbal/2.3/class-Doctrine.DBAL.Connection.html#_createQueryBuilder.

Such links make it much easier to understand and use the documented features in real applications.

@Ocramius
Copy link
Member

Don't think we'd be able to do that automatically.

Closing here btw, this is a feature that could be built on https://github.com/doctrine/doctrine-website-sphinx

Consider reporting it there if you have a plan on how to implement this. Automation is required for that though.

@Ocramius
Copy link
Member

doc

@jkufner
Copy link
Author

jkufner commented Aug 11, 2017

Doxygen does this automatically, even in Markdown pages.

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