Template:Class doclink
Given a class name implemented by mediawiki/core
, this renders a link to automatically-generated documentation for the class at https://doc.wikimedia.org/mediawiki-core/master/php/
Code | Preview |
---|---|
{{class doclink|MediaWiki\Output\OutputPage}} |
MediaWiki\Output\OutputPage |
{{class doclink|MediaWiki\Request\WebRequest|WebRequest}} |
WebRequest |
{{class doclink|class=MediaWiki\Context\RequestContext|RequestContext}} |
MediaWiki\Context\RequestContext |
{{class doclink|MediaWiki\Config\Config|Config|type=interface}} |
Config |
{{class doclink|Wikimedia\Rdbms\Database|Wikimedia\Rdbms\Database::select|anchor=a3b03dd27f434aabfc8d2d639d1e5fa9a}} |
Wikimedia\Rdbms\Database::select |
{{class doclink|class=Wikimedia\Rdbms\Database|text=Wikimedia\Rdbms\Database::select|anchor=a3b03dd27f434aabfc8d2d639d1e5fa9a}} |
Wikimedia\Rdbms\Database::select |
Parameters
Renders a link to automatically-generated documentation for a class or method at https://doc.wikimedia.org/mediawiki-core/master/php/
Parameter | Description | Type | Status | |
---|---|---|---|---|
class name | 1 class | Fully qualified class name.
| String | required |
text | 2 text | Link text.
| String | optional |
anchor | anchor | URL anchor. Used for linking to a specific property or method of the class.
| String | optional |
type | type | Type of the entity: class or interface. (With the current documentation structure, it's not possible to link traits.) Required if it's not a class.
| String | optional |
Project / extension name | project | Project name, from https://doc.wikimedia.org/index/ . For extensions, this is just the name of the extension. For most other things, it is the repository name, with dashes instead of slashes.
| String | optional |
branch | branch | Git branch (if not master).
| String | optional |
See also
- {{Class }} links to the implicit Manual:ClassName.php wiki page
- {{MW file }} renders a table for a PHP file in core, including doc links for the classes implemented by it
- {{Method doclink }} to link to a particular method
- {{File doclink }}
- {{Js doclink }} for Javascript API links