docs(webcal): Optimised javadoc

This commit is contained in:
Zihlu Wang
2023-08-07 08:05:35 +08:00
parent aea5266da5
commit e5a89af04f
2 changed files with 36 additions and 9 deletions
@@ -56,19 +56,45 @@ public final class WebCalendar {
*/ */
private final static String TAG = "VCALENDAR"; private final static String TAG = "VCALENDAR";
// Calendar properties /**
* The name of this calendar.
*/
private String name; private String name;
/**
* The company who produces this calendar.
*
* <p>
* This property will be used in {@code PRODID}.
*/
private String companyName; private String companyName;
/**
* The product name.
*
* <p>
* This property will be used in {@code PRODID}
*/
private String productName; private String productName;
/**
* The producer's domain name.
*/
private String domainName; private String domainName;
/**
* Scale of this calendar.
*/
private final String scale = "GREGORIAN"; private final String scale = "GREGORIAN";
/**
* The method of this calendar.
*/
private String method; private String method;
/**
* The version of this calendar.
*/
private final String version = "2.0"; private final String version = "2.0";
/** /**
@@ -17,6 +17,8 @@
package cn.org.codecrafters.webcal.config; package cn.org.codecrafters.webcal.config;
import lombok.Getter;
/** /**
* The Classification enum represents the classification levels of calendar * The Classification enum represents the classification levels of calendar
* content based on RFC 5545. * content based on RFC 5545.
@@ -43,6 +45,7 @@ package cn.org.codecrafters.webcal.config;
* @version 1.0.0 * @version 1.0.0
* @since 1.0.0 * @since 1.0.0
*/ */
@Getter
public enum Classification { public enum Classification {
/** /**
@@ -73,6 +76,12 @@ public enum Classification {
CONFIDENTIAL("CONFIDENTIAL"), CONFIDENTIAL("CONFIDENTIAL"),
; ;
/**
* -- GETTER --
* Get the string representation of the classification level.
*
* @return the string representation of the classification level
*/
private final String classification; private final String classification;
/** /**
@@ -84,12 +93,4 @@ public enum Classification {
this.classification = classification; this.classification = classification;
} }
/**
* Get the string representation of the classification level.
*
* @return the string representation of the classification level
*/
public String getClassification() {
return classification;
}
} }