phpDocumentor / phpDocumentor/phpDocumentor

FQSEN for the file Structural Element

Open
#1,987 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
PHP
Stars
4.3k
Forks
648
Avg merge
28m
Merged PRs (30d)
13

Description

Guys, I've spent hours to find out how to reference a file using @see and still no success ..

The closest I've got is:

* @see ::archive-source.html Archive source

which links to "file:///home/cs/work/log-lolla-pro-dev/doc/files/%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20::archive-source.html"

Thank you :)

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

No source file or test is named. Start by reproducing the @see ::archive-source.html example and trace how @see targets for file structural elements are parsed and rendered; done means the generated link points to archive-source.html without the whitespace-prefixed file URL.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.