mirror of
https://github.com/doctrine/orm.git
synced 2026-03-24 06:52:09 +01:00
Documentation should link API #5639
Reference in New Issue
Block a user
Delete Branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Originally created by @jkufner on GitHub (Aug 11, 2017).
Originally assigned to: @Ocramius on GitHub.
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#createQueryBuildershould 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 commented on GitHub (Aug 11, 2017):
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 commented on GitHub (Aug 11, 2017):
doc
@jkufner commented on GitHub (Aug 11, 2017):
Doxygen does this automatically, even in Markdown pages.