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 bullets in CoreModelObject Javadoc #24

Merged
merged 4 commits into from
Jan 26, 2025
Merged

Conversation

bact
Copy link
Collaborator

@bact bact commented Jan 26, 2025

  • Add <ul> <li> HTML markups to CoreModelObject so the bullet lists display properly in the API doc
  • Also add descriptions to NotEquivalent Enums and TypedValue constructor.

See screenshot comparisons below.

Demo: https://bact.github.io/spdx-java-core/

--

CoreModelObject unformatted:
CoreModelObject unformatted

CoreModelObject formatted:
CoreModelObject formatted

--

Enum without descriptions:
Enum without descriptions

Enum with descriptions:
Enum with descriptions

bact added 3 commits January 26, 2025 10:39
Add <ul> <li> HTML markups to CoreModelObject so the bullet lists display properly in the API doc

Also add description to NotEquivalent Enums

Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@bact bact added the documentation Improvements or additions to documentation label Jan 26, 2025
@bact bact requested a review from goneall January 26, 2025 11:05
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Copy link
Member

@goneall goneall left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - Thanks @bact

@goneall goneall merged commit 4c6fb7f into spdx:main Jan 26, 2025
3 checks passed
@bact bact deleted the fix-javadoc-bullets branch January 26, 2025 20:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants