FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Give phpdoc reference stubs proper titles so they appear in the ToC by lacatoire · Pull Request #4116 · phpDocumentor/phpDocumentor · GitHub

Give phpdoc reference stubs proper titles so they appear in the ToC - #4116

Open
lacatoire wants to merge 1 commit into
phpDocumentor:masterfrom
lacatoire:fix/issue-3759-phpdoc-reference-toc
Open

lacatoire wants to merge 1 commit into
phpDocumentor:masterfrom
lacatoire:fix/issue-3759-phpdoc-reference-toc

Conversation

Copy link
Copy Markdown
Contributor

The Tag reference and Inline tag reference tables of content on docs.phpdoc.org rendered <Unknown> entries for six .rst files whose only body was a .. include:: <other>.rst line (see #3759). Without a top-level title, the toctree could not extract a label for them.

Replace each include with a proper RST title matching the tag name plus a short cross-reference and a one-liner that spells out the variant's specific semantics. Users landing on each URL still get a clear pointer to the canonical reference page.

Affected files:

  • docs/references/phpdoc/tags/property-read.rst (@property-read)
  • docs/references/phpdoc/tags/property-write.rst (@property-write)
  • docs/references/phpdoc/inline-tags/example.rst (@example)
  • docs/references/phpdoc/inline-tags/internal.rst (@internal)
  • docs/references/phpdoc/inline-tags/link.rst (@link)
  • docs/references/phpdoc/inline-tags/see.rst (@see)

Inline-tag titles follow the existing inheritdoc.rst convention (bare @tag, no braces) so the inline-tags toctree stays visually uniform.

Fixes #3759

The 'Tag reference' and 'Inline tag reference' tables of content
rendered <Unknown> entries for the six .rst files whose only body was
a .. include:: <other>.rst line. Without a top-level title, the
toctree could not extract a label for them.

Replace each include with a proper RST title matching the tag name
plus a short cross-reference and a one-liner that spells out the
variant's specific semantics. Users landing on each URL still get a
clear pointer to the canonical reference page.

Fixes phpDocumentor#3759
lacatoire force-pushed the fix/issue-3759-phpdoc-reference-toc branch from eb8cfba to 8000636 Compare April 17, 2026 20:13
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

The table of content of the phpdoc reference is broken

1 participant


Back | FazBrowse Home | New Git URL