chore: Add javadoc [DHIS2-18370]

dhis2 · Jan 20, 2025 · 68c6746 · 68c6746
1 parent 21f8b2d
commit 68c6746
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/...2/dhis-api/src/main/java/org/hisp/dhis/program/ProgramDataElementOptionDimensionItem.java b/...2/dhis-api/src/main/java/org/hisp/dhis/program/ProgramDataElementOptionDimensionItem.java
@@ -50,6 +50,7 @@
 import org.hisp.dhis.common.BaseDimensionalItemObject;
 import org.hisp.dhis.common.BaseIdentifiableObject;
 import org.hisp.dhis.common.DimensionItemType;
+import org.hisp.dhis.common.DimensionalItemObject;
 import org.hisp.dhis.common.EmbeddedObject;
 import org.hisp.dhis.common.IdScheme;
 import org.hisp.dhis.common.ValueType;
@@ -60,6 +61,12 @@
 import org.hisp.dhis.option.OptionSet;
 import org.hisp.dhis.schema.annotation.Property;
 
+/**
+ * This class represents the junction of a {@link Program}, {@link DataElement}, {@link Option} and
+ * the respective {@link Aggregation}. It's mainly used as a dimensional item ({@link
+ * DimensionalItemObject}), in visualization objects. ie: {@link
+ * org.hisp.dhis.visualization.Visualization}
+ */
 @NoArgsConstructor
 @JacksonXmlRootElement(localName = "programDataElementOptionDimension", namespace = DXF_2_0)
 public class ProgramDataElementOptionDimensionItem extends BaseDimensionalItemObject

diff --git a/...src/main/java/org/hisp/dhis/program/ProgramTrackedEntityAttributeOptionDimensionItem.java b/...src/main/java/org/hisp/dhis/program/ProgramTrackedEntityAttributeOptionDimensionItem.java
@@ -49,13 +49,20 @@
 import org.hisp.dhis.common.BaseDimensionalItemObject;
 import org.hisp.dhis.common.BaseIdentifiableObject;
 import org.hisp.dhis.common.DimensionItemType;
+import org.hisp.dhis.common.DimensionalItemObject;
 import org.hisp.dhis.common.EmbeddedObject;
 import org.hisp.dhis.common.IdScheme;
 import org.hisp.dhis.legend.LegendSet;
 import org.hisp.dhis.option.Option;
 import org.hisp.dhis.schema.annotation.Property;
 import org.hisp.dhis.trackedentity.TrackedEntityAttribute;
 
+/**
+ * This class represents the junction of a {@link Program}, {@link TrackedEntityAttribute}, {@link
+ * Option} and the respective {@link Aggregation}. It's mainly used as a dimensional item ({@link
+ * DimensionalItemObject}), in visualization objects. ie: {@link
+ * org.hisp.dhis.visualization.Visualization}
+ */
 @NoArgsConstructor
 @JacksonXmlRootElement(localName = "programAttributeOptionDimension", namespace = DXF_2_0)
 public class ProgramTrackedEntityAttributeOptionDimensionItem extends BaseDimensionalItemObject