cakephp-api-docs icon indicating copy to clipboard operation
cakephp-api-docs copied to clipboard

API Docs Links appear broken

Open danial-k opened this issue 2 years ago • 2 comments

Description

Viewing API Documentation on the web, e.g. RecordNotFoundException, shows the raw link string instead of an actual hyperlink, e.g.:

Array of headers to be passed to {@link \Cake\Http\Response::withHeader()}

It doesn't seem that the files containing the links are the issue, e.g. CakeException.php hasn't changed in ~two years, perhaps the docs builder/link generator has started failing?

image

CakePHP Version

4.4.0

PHP Version

No response

danial-k avatar Jul 04 '23 06:07 danial-k

This is likely an issue with the API documentation generator. I'm not sure it supports inline link annotations anymore.

markstory avatar Jul 04 '23 14:07 markstory

@link is supposed to refer to a URL, @see is supposed to be use for referring to other methods.

But it probably doesn't support inline, inline @see doesn't work too https://api.cakephp.org/4.4/class-Cake.Mailer.Email.html#deliver()

garas avatar Jul 04 '23 17:07 garas