Skip to content

Commit

Permalink
Merge pull request #2 from spdx/classdoc
Browse files Browse the repository at this point in the history
Improve class level JavaDocs
  • Loading branch information
goneall authored Sep 3, 2024
2 parents a06c48b + 6b3be6b commit 917257a
Show file tree
Hide file tree
Showing 8 changed files with 15 additions and 11 deletions.
3 changes: 2 additions & 1 deletion src/main/java/org/spdx/library/model/v2/ModelObjectV2.java
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,6 @@
import org.spdx.storage.PropertyDescriptor;

/**
* @author Gary O'Neall
*
* Superclass for all SPDX spec version 2 model objects
*
Expand Down Expand Up @@ -92,6 +91,8 @@
*
* This class also handles the conversion of a ModelObjectV2 to and from a TypeValue for storage in the ModelStore.
*
* @author Gary O'Neall
*
*/
public abstract class ModelObjectV2 extends CoreModelObject {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,6 @@
* @author Gary O'Neall
*
*/
/**
* @author gary
*
*/
public class RelatedElementCollection implements Collection<SpdxElement> {

static final Logger logger = LoggerFactory.getLogger(RelatedElementCollection.class);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,9 @@
import org.spdx.storage.IModelStore;

/**
* @author gary
* Provides the necessary information for forward and backward compatibility for processing tools.
*
* @author Gary O'Neall
*
*/
public class SpdxCreatorInformation extends ModelObjectV2 {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,10 @@
import org.spdx.storage.IModelStore.IdType;

/**
* @author Gary O'Neall
*
* Compatible model info for all supported spec version 2 (2.0, 2.1, 2.2, 2.2.1, 2.3)
*
* @author Gary O'Neall
*/
public class SpdxModelInfoV2_X implements ISpdxModelInfo {

Expand Down
3 changes: 2 additions & 1 deletion src/main/java/org/spdx/library/model/v2/SpdxNone.java
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,11 @@
import org.spdx.core.IndividualUriValue;

/**
* @author Gary O'Neall
*
* Represents either a NoneLicense OR a NoneElement - the correct class should
* be replaced by the caller based on the context
*
* @author Gary O'Neall
*/
public class SpdxNone implements IndividualUriValue {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,9 @@
import org.spdx.storage.IModelStore;

/**
* @author gary
*
* Verification Code for packages
*
* @author Gary O'Neall
*/
public class SpdxPackageVerificationCode extends ModelObjectV2 {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@
import org.spdx.storage.compatv2.CompatibleModelStoreWrapper;

/**
* @author Gary O'Neall
*
* This class represents an ExtractedLicenseInfo which is stored in an external SPDX document.
*
Expand All @@ -57,6 +56,8 @@
* NOTE that this implementation is different from the previous major version of the SPDX Library.
* The documentUri is the documentUri where the extractedLicenseRef can be found.
* The ID is the ID for the LicenseRef in the external document.
*
* @author Gary O'Neall
*
*/
public class ExternalExtractedLicenseInfo extends AbstractExtractedLicenseInfo implements IndividualUriValue {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@
import org.spdx.storage.IModelStore;

/**
* Pointer for lines and characters
*
* @author Gary O'Neall
*
*/
Expand Down

0 comments on commit 917257a

Please sign in to comment.