Skip to content

Commit 5ee7d5a

Browse files
committed
Fix build W
1 parent c50501b commit 5ee7d5a

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

source/codingstandards.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -288,7 +288,7 @@ Override method: @inheritDoc? @see? docblock? no docblock?
288288

289289
There are many question regarding the way to document a child method in a child class.
290290

291-
Many editors use the ``{@inheritDoc}`` tag without anything else. **This is wrong**. This *inline* tag is confusing for many users; for more details, see the `PHPDocumentor documentation about it <https://www.phpdoc.org/docs/latest/guides/inheritance.html#the-inheritdoc-tag>`_.
291+
Many editors use the ``{@inheritDoc}`` tag without anything else. **This is wrong**. This *inline* tag is confusing for many users; for more details, see the `PHPDocumentor documentation about it <https://www.phpdoc.org/docs/latest/guides/inheritance.html#the-inheritdoc-tag>`__.
292292
This tag usage is not forbidden, but make sure to use it properly, or just avoid it. An usage exemple:
293293

294294
.. code-block:: php
@@ -319,7 +319,7 @@ This tag usage is not forbidden, but make sure to use it properly, or just avoid
319319
[...]
320320
}
321321
322-
Something we can see quite often is just the usage of the ``@see`` tag to make reference to the parent method. **This is wrong**. The ``@see`` tag is designed to reference another method that would help to understand this one; not to make a reference to its parent (you can also take a look at `PHPDocumentor documentation about it <https://www.phpdoc.org/docs/latest/references/phpdoc/tags/see.html>`_. While generating, parent class and methods are automaticaly discovered; a link to the parent will be automatically added.
322+
Something we can see quite often is just the usage of the ``@see`` tag to make reference to the parent method. **This is wrong**. The ``@see`` tag is designed to reference another method that would help to understand this one; not to make a reference to its parent (you can also take a look at `PHPDocumentor documentation about it <https://www.phpdoc.org/docs/latest/references/phpdoc/tags/see.html>`__. While generating, parent class and methods are automaticaly discovered; a link to the parent will be automatically added.
323323
An usage example:
324324

325325
.. code-block:: php

0 commit comments

Comments
 (0)