phpDocumentor / phpDocumentor/phpDocumentor

3.0.0-RC: @package partially not inherited for "classless functions/constants"

Open
#2,318 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

help wanted template Up-for-grabs
Dominant language
PHP
Stars
4.3k
Forks
648
Avg merge
28m
Merged PRs (30d)
13

Description

  • file docblock has @package ContentLounge-RTE
  • Packages -> Contentlounge -> RTE is so far fine

ContentLounge-RTE.html looks pretty fine

but all anchros have "/namespaces/default.html#constant_LOUNGE_AREA_LOADED" or "namespaces/default.html#function_RTE_Action"

they should point to "ContentLounge-RTE.html#anchor" instead "default.html#anchor"

maybe that's one of the reasons of the empty "Default" package in the navigation

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Compare the generated ContentLounge-RTE.html and namespaces/default.html outputs, focusing on the anchors for LOUNGE_AREA_LOADED and RTE_Action and how the file-level @package is applied. Trace the generation path for classless functions and constants, then verify that their links target ContentLounge-RTE.html and that the empty Default package no longer contains them.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.