Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API Docs Links appear broken #308

Open
danial-k opened this issue Jul 4, 2023 · 2 comments
Open

API Docs Links appear broken #308

danial-k opened this issue Jul 4, 2023 · 2 comments

Comments

@danial-k
Copy link

danial-k commented Jul 4, 2023

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

@markstory
Copy link
Member

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

@garas
Copy link
Member

garas commented Jul 4, 2023

@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()

@othercorey othercorey transferred this issue from cakephp/cakephp Jul 7, 2023
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

No branches or pull requests

3 participants