-
Notifications
You must be signed in to change notification settings - Fork 2
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
Add API doc website #69
base: master
Are you sure you want to change the base?
Conversation
Signed-off-by: Arthit Suriyawongkul <[email protected]>
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]>
Signed-off-by: Arthit Suriyawongkul <[email protected]>
There was a problem hiding this 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.
@bact - If you could rebase to the latest, it should fix the CI failure |
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 |
Signed-off-by: Arthit Suriyawongkul <[email protected]> Co-authored-by: Gary O'Neall <[email protected]>
Signed-off-by: Arthit Suriyawongkul <[email protected]> Co-authored-by: Gary O'Neall <[email protected]>
Signed-off-by: Arthit Suriyawongkul <[email protected]> Co-authored-by: Gary O'Neall <[email protected]>
Signed-off-by: Arthit Suriyawongkul <[email protected]>
…ava-tagvalue-store into add-api-docs-website
@goneall I have add back the short license header as suggested. Note that the guideline you have mentioned is probably for the code that is developed at the Apache Software Foundation. From https://www.apache.org/legal/apply-license.html - there's a link to the short license header at https://www.apache.org/legal/src-headers.html#headers and it said: "Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership" and the NOTICE file https://www.apache.org/legal/src-headers.html#notice said: "Apache [PRODUCT_NAME] Copyright [XXXX-XXXX] The Apache Software Foundation This product includes software developed at. The Apache Software Foundation (/)." -- Btw, for the URL changes, the guideline also said: "https is acceptable in place of http for the URL" |
Signed-off-by: Arthit Suriyawongkul <[email protected]>
Signed-off-by: Arthit Suriyawongkul <[email protected]>
<text> </text>
in Javadoc, it has to be escaped@author
toSPDX-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)