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

docs: use appropriate javadoc url syntax #77

Merged
merged 1 commit into from
Jun 15, 2023
Merged

docs: use appropriate javadoc url syntax #77

merged 1 commit into from
Jun 15, 2023

Conversation

y-lakhdar
Copy link
Contributor

@y-lakhdar y-lakhdar commented Jun 15, 2023

Use javadoc syntax as explained in the Javadoc Reference Guide.

In this PR, I simply formatted URLs like

See [Content Security](https://docs.coveo.com/en/1779)

into

@see <a href="https://docs.coveo.com/en/1779">Content Security</a>

Before

image

After

image

@y-lakhdar y-lakhdar requested a review from a team as a code owner June 15, 2023 18:04
@y-lakhdar y-lakhdar requested review from olamothe, louis-bompart and mrrajamanickam-coveo and removed request for a team June 15, 2023 18:04
@github-actions
Copy link

Dependency Review

✅ No vulnerabilities or license issues found.

Scanned Manifest Files

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

Successfully merging this pull request may close these issues.

2 participants