Skip to content

Commit 36a5c07

Browse files
committed
docs: rephase DataSet related Javadocs more concise and informative
1 parent a2c0350 commit 36a5c07

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

src/main/java/edu/kit/datamanager/ro_crate/entities/data/DataSetEntity.java

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,11 @@ public class DataSetEntity extends DataEntity {
2222
public static final String TYPE = "Dataset";
2323

2424
/**
25-
* The hasPart property is used to indicate that the described resource is a
26-
* composite resource, and to point to the parts that it includes.
25+
* Points to the parts of this dataset.
26+
* <p>
27+
* This will be serialized to and deserialized from the "hasPart" property
28+
* and exists for convenience to represent the additional capabilities of
29+
* a DataSetEntity over a normal DataEntity.
2730
*/
2831
@JsonSerialize(using = HasPartSerializer.class)
2932
@JsonInclude(JsonInclude.Include.NON_EMPTY)

src/test/java/edu/kit/datamanager/ro_crate/crate/HasPartTest.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@
1818
import static org.junit.jupiter.api.Assertions.*;
1919

2020
/**
21-
* Test similar to AutomaticHierarchyRecognitionTest
21+
* Tests related to the addDataEntity(DataEntity, String) method and the hasPart
22+
* property.
2223
*/
2324
public class HasPartTest {
2425

0 commit comments

Comments
 (0)