[PSR-19] Class and methods links

34 views
Skip to first unread message

Marcos Passos

unread,
Nov 15, 2018, 9:17:01 AM11/15/18
to PHP Framework Interoperability Group
Hello everyone!

Reading PSR-19 I could not find any mention to the use of @link to link constants, methods, and classes. Such a feature allows navigating between documents easier.

Any plans to covers it?

- Marcos

Chuck Burgess

unread,
Nov 15, 2018, 9:22:21 AM11/15/18
to php...@googlegroups.com
Yes, I plan to reintroduce that. The current draft has aspects to it that date way back to efforts in phpDocumentor to deprecate some things, including the @link tag completely.

I'm guiding the Working Group through reviews of individual tags right now, and already have this topic as a point to bring up when we get to the @link tag.

Still, thanks for noticing and speaking up 😎👍
CRB

--
You received this message because you are subscribed to the Google Groups "PHP Framework Interoperability Group" group.
To unsubscribe from this group and stop receiving emails from it, send an email to php-fig+u...@googlegroups.com.
To post to this group, send email to php...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/php-fig/2a1bb268-707f-49eb-8bb6-a6e6660df979%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

Marcos Passos

unread,
Nov 15, 2018, 9:30:15 AM11/15/18
to PHP Framework Interoperability Group
Thank you for the quick and welcoming reply.

I believe it also should cover naming resolution rules, to avoid having some tools supporting relative class names and others fully-qualified only. My suggestion here is to resolve in the same way PHP does: names are determined based on the current namespace, import statements, or requires being fully-qualified. This strategy is the same that JavaDocs adopts. 

- Marcos

Chuck Burgess

unread,
Nov 15, 2018, 9:35:50 AM11/15/18
to php...@googlegroups.com
Yes indeed... such resolution behavior goes back to phpDocumentor 1.x... well, the namespace resolution doesn't, but it still applies.
CRB

Reply all
Reply to author
Forward
0 new messages