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

Fix javadoc in example #1714

Merged
merged 1 commit into from
Aug 3, 2021
Merged

Conversation

idelpivnitskiy
Copy link
Member

Motivation:

./gradlew javadoc command fails due to some javadoc rules violations
in examples.

Modifications:

  • Don't use self-closing tags;
  • Fix a link attribute for a tag;
  • Use <pre> + {@code ...} to not worry about manual chars escape;

Result:

./gradlew javadoc command is happy.

Motivation:

`./gradlew javadoc` command fails due to some javadoc rules violations
in examples.

Modifications:

- Don't use self-closing tags;
- Fix a link attribute for `a` tag;
- Use `<pre>` + `{@code ...}` to not worry about manual chars escape;

Result:

`./gradlew javadoc` command is happy.
@bondolo
Copy link
Contributor

bondolo commented Aug 3, 2021

Even though we do not publish the examples JavaDocs should we perhaps generate it during all builds (it won't take much time, probably < 1second) to ensure that it remains compliant?

@idelpivnitskiy
Copy link
Member Author

@bondolo makes sense! We can handle it separately. I've created an issue #1715 to keep track of it.

@idelpivnitskiy idelpivnitskiy merged commit 8ee20bb into apple:main Aug 3, 2021
@idelpivnitskiy idelpivnitskiy deleted the fix-javadoc branch August 3, 2021 19:15
idelpivnitskiy added a commit that referenced this pull request Aug 17, 2021
Motivation:

`./gradlew javadoc` command fails due to some javadoc rules violations
in examples.

Modifications:

- Don't use self-closing tags;
- Fix a link attribute for `a` tag;
- Use `<pre>` + `{@code ...}` to not worry about manual chars escape;

Result:

`./gradlew javadoc` command is happy.
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