Skip to content

Commit 0d0ed3b

Browse files
bactgoneall
authored andcommitted
Put @tag at the bottom of Javadoc comment block
To fix the issues that some of the Javadoc information do not show in the API documentation website Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
1 parent 26cb9fe commit 0d0ed3b

80 files changed

Lines changed: 95 additions & 128 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

src/main/java/org/spdx/Configuration.java

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,17 @@
2525
import org.slf4j.LoggerFactory;
2626

2727
/**
28-
* The configuration class for the Spdx-Java-Library. When a caller attempts to retrieve a configuration property, it
28+
* The configuration class for the Spdx-Java-Library
29+
* <p>
30+
* When a caller attempts to retrieve a configuration property, it
2931
* will first be checked in the Java system properties (i.e. set via `-D` command line options to the JVM, or by
3032
* programmatic calls to `System.setProperty()` in code), and will then fall back on a properties file in the classpath.
3133
* That file must be called `/resources/spdx-java-library.properties`.
3234
* <p>
3335
* Please see the documentation for specifics on what configuration options Spdx-Java-Library supports, and how they
3436
* impact the library's behavior.
37+
*
38+
* @author Gary O'Neall
3539
*/
3640
public final class Configuration {
3741
private static final Logger logger = LoggerFactory.getLogger(Configuration.class.getName());

src/main/java/org/spdx/library/LicenseInfoFactory.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@
4242

4343
/**
4444
* Factory for creating SPDXLicenseInfo objects from a Jena model
45+
*
4546
* @author Gary O'Neall
4647
*/
4748
@SuppressWarnings("unused")

src/main/java/org/spdx/library/ListedLicenses.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,6 @@
4848
* Singleton class which holds the listed licenses
4949
*
5050
* @author Gary O'Neall
51-
*
5251
*/
5352
@SuppressWarnings({"UnusedReturnValue", "unused"})
5453
public class ListedLicenses {

src/main/java/org/spdx/library/ModelCopyManager.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,6 @@
5050
* This object can be passed into the constructor for ModelObjects to allow the objects to be copied.
5151
*
5252
* @author Gary O'Neall
53-
*
5453
*/
5554
@SuppressWarnings("unused")
5655
public class ModelCopyManager implements IModelCopyManager {

src/main/java/org/spdx/library/SpdxConversionException.java

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,10 @@
2020
import org.spdx.core.InvalidSPDXAnalysisException;
2121

2222
/**
23-
* @author gary
24-
*
23+
* Exception thrown when there is an error during the conversion of SPDX
24+
* documents
25+
*
26+
* @author Gary O'Neall
2527
*/
2628
@SuppressWarnings("unused")
2729
public class SpdxConversionException extends InvalidSPDXAnalysisException {

src/main/java/org/spdx/library/SpdxModelFactory.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,6 @@
4949
* The <code>inflateModelObject</code> methods will create an initial object based on the name of the type
5050
*
5151
* @author Gary O'Neall
52-
*
5352
*/
5453
@SuppressWarnings("unused")
5554
public class SpdxModelFactory {

src/main/java/org/spdx/library/conversion/ExternalMapInfo.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,9 @@
3333
import org.spdx.storage.IModelStore.IdType;
3434

3535
/**
36-
* @author Gary O'Neall
37-
*
3836
* Information about an ExternalMap captured from an ExternalDocumentRef
3937
*
38+
* @author Gary O'Neall
4039
*/
4140
@SuppressWarnings("unused")
4241
public class ExternalMapInfo {

src/main/java/org/spdx/library/conversion/ISpdxConverter.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,9 @@
1818
package org.spdx.library.conversion;
1919

2020
/**
21-
* @author Gary O'Neall
22-
*
2321
* Interface for classes that can convert from one SPDX spec version to another
2422
*
23+
* @author Gary O'Neall
2524
*/
2625
public interface ISpdxConverter {
2726

src/main/java/org/spdx/library/conversion/Spdx2to3Converter.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,11 +87,10 @@
8787
import org.spdx.storage.listedlicense.SpdxListedLicenseModelStore;
8888

8989
/**
90-
* @author Gary O'Neall
91-
* <p>
9290
* Converts SPDX spec version 2.X objects to SPDX spec version 3.X and stores the result in the
9391
* toModelStore
9492
*
93+
* @author Gary O'Neall
9594
*/
9695
@SuppressWarnings({"OptionalGetWithoutIsPresent", "LoggingSimilarMessage"})
9796
public class Spdx2to3Converter implements ISpdxConverter {

src/main/java/org/spdx/library/conversion/package-info.java

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,11 @@
1616
* limitations under the License.
1717
*/
1818
/**
19-
* @author Gary O'Neall
20-
*
21-
* This package contains classes that convert between major versions of SPDX
19+
* Classes that convert between major versions of SPDX
2220
*
2321
* These classes can be used directly (e.g. from a web application or CLI) or
2422
* from the <code>CopyManager</code>.
2523
*
24+
* @author Gary O'Neall
2625
*/
2726
package org.spdx.library.conversion;

0 commit comments

Comments
 (0)