Skip to content

[DOCS] Fix links to api docs #1077

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

Merged
merged 1 commit into from
Sep 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
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
PHP_DOC = docker run --rm -v ${PWD}:/data -w /data phpdoc/phpdoc:3-unstable

.PHONY: help
help: ## Displays this list of targets with descriptions
Expand Down Expand Up @@ -90,7 +91,7 @@ add-license:

.PHONY: docs
docs: ## Render documentation
$(PHP_BIN) tools/phpDocumentor.phar
$(PHP_DOC) run

.PHONY: docs-watch
docs-watch: ## Render documentation and watch for changes
Expand Down
6 changes: 3 additions & 3 deletions docs/components/guidesXml.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ it at :file:`packages/guides-cli/resources/schema/guides.xsd` in the
mono repository.

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

.. seealso::

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

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

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

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

.. todo: Add example
8 changes: 4 additions & 4 deletions docs/developers/compiler.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ Also, this guide assumes you have an :ref:`extension <developer-extension>` set

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

- Implement a :php:class:`phpDocumentor\Guides\Compiler\NodeTransformer`
- Implement a :php:class:`phpDocumentor\Guides\Compiler\CompilerPass`
- Implement a :php:interface:`phpDocumentor\Guides\Compiler\NodeTransformer`
- Implement a :php:interface:`phpDocumentor\Guides\Compiler\CompilerPass`

NodeTransformer
===============

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

.. code-block:: php
Expand All @@ -40,7 +40,7 @@ CompilerPass
============

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

.. code-block:: php
Expand Down
Loading