Skip to content

Add API doc website#69

Merged
goneall merged 16 commits intospdx:masterfrom
bact:add-api-docs-website
Feb 12, 2025
Merged

Add API doc website#69
goneall merged 16 commits intospdx:masterfrom
bact:add-api-docs-website

Conversation

@bact
Copy link
Collaborator

@bact bact commented Feb 1, 2025

  • Add API doc build workflow
  • Fix <text> </text> in Javadoc, it has to be escaped
  • Fix few other Javadoc
  • Convert @author to SPDX-FileContributor

Demo: https://bact.github.io/spdx-java-tagvalue-store/

(Note: a Pages settings to point to gh-pages branch is needed after merge + CI run)

bact added 6 commits December 21, 2024 12:14
Signed-off-by: Arthit Suriyawongkul <[email protected]>
Signed-off-by: Arthit Suriyawongkul <[email protected]>
The tag is not recognisable by Javadoc, has to escaped it.

Signed-off-by: Arthit Suriyawongkul <[email protected]>
Signed-off-by: Arthit Suriyawongkul <[email protected]>
Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact bact added the documentation Improvements or additions to documentation label Feb 1, 2025
Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact bact requested a review from goneall February 1, 2025 08:50
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.

Let's leave the original notice texts in the source file since it is recommended by the Apache software foundation: https://www.apache.org/legal/apply-license.html

The other changes is to keep Java 8 compliance - last time I tried to change that, I got complaints from the user community that their company is still using Java 8.

@goneall
Copy link
Member

goneall commented Feb 1, 2025

@bact - If you could rebase to the latest, it should fix the CI failure

@goneall
Copy link
Member

goneall commented Feb 1, 2025

Since I would like to get a release out today and this change is mostly documentation, I'll include it in the the next release after 2.0.0-RC2

@bact
Copy link
Collaborator Author

bact commented Feb 2, 2025

Let's leave the original notice texts in the source file since it is recommended by the Apache software foundation: https://www.apache.org/legal/apply-license.html

@goneall I have add back the short license header as suggested.

Note that the guideline you have mentioned is for the code that is developed at the Apache Software Foundation.

So it is a guideline for Apache products, not a guideline for Apache license.

--

Btw, for the URL changes, the guideline also said:

"https is acceptable in place of http for the URL"

@bact bact requested a review from goneall February 12, 2025 04:06
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 ce9d060 into spdx:master Feb 12, 2025
1 check passed
@bact bact deleted the add-api-docs-website branch February 12, 2025 04:44
@bact
Copy link
Collaborator Author

bact commented Feb 12, 2025

Note: a Pages settings to point to gh-pages branch is needed after merge.

Update: Done. API doc avail at https://spdx.github.io/spdx-java-tagvalue-store/

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