Skip to content

Commit e2b3fef

Browse files
authored
Merge pull request #1077 from phpDocumentor/docs-fix-links
[DOCS] Fix links to api docs
2 parents eea9e63 + 5a45ddc commit e2b3fef

File tree

3 files changed

+9
-8
lines changed

3 files changed

+9
-8
lines changed

Makefile

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
PHP_BIN = docker run -it --rm --user $$(id -u):$$(id -g) -v${PWD}:/opt/project -w /opt/project php:8.2-cli php -d memory_limit=1024M
2+
PHP_DOC = docker run --rm -v ${PWD}:/data -w /data phpdoc/phpdoc:3-unstable
23

34
.PHONY: help
45
help: ## Displays this list of targets with descriptions
@@ -90,7 +91,7 @@ add-license:
9091

9192
.PHONY: docs
9293
docs: ## Render documentation
93-
$(PHP_BIN) tools/phpDocumentor.phar
94+
$(PHP_DOC) run
9495

9596
.PHONY: docs-watch
9697
docs-watch: ## Render documentation and watch for changes

docs/components/guidesXml.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ it at :file:`packages/guides-cli/resources/schema/guides.xsd` in the
3737
mono repository.
3838

3939
Register the new configuration option in the :php:`TreeBuilder` at
40-
:php:func:`phpDocumentor\Guides\DependencyInjection\GuidesExtension::getConfigTreeBuilder`.
40+
:php:method:`phpDocumentor\Guides\DependencyInjection\GuidesExtension::getConfigTreeBuilder()`.
4141

4242
.. seealso::
4343

@@ -60,7 +60,7 @@ Save a configuration value into the :php:`ProjectSettings`
6060

6161
To add a configuration value to the :php:`ProjectSettings`,
6262
register the setting in
63-
:php:func:`phpDocumentor\Guides\DependencyInjection\GuidesExtension::load`.
63+
:php:method:`phpDocumentor\Guides\DependencyInjection\GuidesExtension::load()`.
6464

6565
.. code-block:: php
6666
:caption: phpDocumentor\Guides\DependencyInjection\GuidesExtension::load
@@ -73,6 +73,6 @@ Save a configuration value to the :php:`ProjectNode`
7373
----------------------------------------------------
7474

7575
Additional settings can be added to the ProjectNode in a
76-
:php:`phpDocumentor\Guides\Event\PostProjectNodeCreated` event.
76+
:php:class:`phpDocumentor\Guides\Event\PostProjectNodeCreated` event.
7777

7878
.. todo: Add example

docs/developers/compiler.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@ Also, this guide assumes you have an :ref:`extension <developer-extension>` set
1010

1111
If you want to extend the compiler to support new features there are two options:
1212

13-
- Implement a :php:class:`phpDocumentor\Guides\Compiler\NodeTransformer`
14-
- Implement a :php:class:`phpDocumentor\Guides\Compiler\CompilerPass`
13+
- Implement a :php:interface:`phpDocumentor\Guides\Compiler\NodeTransformer`
14+
- Implement a :php:interface:`phpDocumentor\Guides\Compiler\CompilerPass`
1515

1616
NodeTransformer
1717
===============
1818

1919
Node transformers are used to transform specific types of nodes in the AST. This is useful when you want to remove
20-
a node type or manipulate nodes of a specific type. Your new node transformer should implement the :php:class:`phpDocumentor\Guides\Compiler\NodeTransformer`
20+
a node type or manipulate nodes of a specific type. Your new node transformer should implement the :php:interface:`phpDocumentor\Guides\Compiler\NodeTransformer`
2121
interface and you should register it in the dependency injection container.
2222

2323
.. code-block:: php
@@ -40,7 +40,7 @@ CompilerPass
4040
============
4141

4242
If you want to do more complex transformations, for example transformations that require multiple nodes to be transformed
43-
you should implement a :php:class:`phpDocumentor\Guides\Compiler\CompilerPass`. A compiler pass needs to be registered
43+
you should implement a :php:interface:`phpDocumentor\Guides\Compiler\CompilerPass`. A compiler pass needs to be registered
4444
just like a node transformer.
4545

4646
.. code-block:: php

0 commit comments

Comments
 (0)