docs(global): Optimised javadocs.

This commit is contained in:
Zihlu Wang
2023-09-15 15:36:25 +08:00
parent baa91f626a
commit 6549373e8d
46 changed files with 177 additions and 214 deletions
@@ -22,11 +22,9 @@ import java.util.List;
/**
* The WebCalendar class represents a web calendar in iCalendar format.
*
* <p>
* It allows users to create and customize calendar components and events and
* generate an iCalendar string containing all the calendar information.
*
* <p>Usage Example:
* <pre>
* WebCalendar calendar = new WebCalendar()
@@ -39,14 +37,13 @@ import java.util.List;
* .addEvent(event2);
* String iCalendarString = calendar.resolve();
* </pre>
*
* <p>
* The WebCalendar class is designed to generate an iCalendar string conforming
* to the iCalendar specification, which can be used to share calendar data
* with other calendar applications or services.
*
* @author Zihlu Wang
* @version 1.0.0
* @version 1.1.0
* @since 1.0.0
*/
public final class WebCalendar {
@@ -41,7 +41,7 @@ import java.util.UUID;
* iCalendar content for the event.
*
* @author Zihlu Wang
* @version 1.0.0
* @version 1.1.0
* @since 1.0.0
*/
public final class WebCalendarEvent extends WebCalendarNode {
@@ -35,7 +35,7 @@ import java.util.List;
* component or event.
*
* @author Zihlu Wang
* @version 1.0.0
* @version 1.1.0
* @since 1.0.0
*/
public abstract sealed class WebCalendarNode
@@ -22,7 +22,6 @@ import lombok.Getter;
/**
* The Classification enum represents the classification levels of calendar
* content based on RFC 5545.
*
* <p>
* Calendar events or components can be classified as one of the following
* levels:
@@ -42,7 +41,7 @@ import lombok.Getter;
* </ul>
*
* @author Zihlu Wang
* @version 1.0.0
* @version 1.1.0
* @since 1.0.0
*/
@Getter
@@ -50,7 +49,6 @@ public enum Classification {
/**
* Public classification level.
*
* <p>
* Indicates that the calendar content is public and can be freely
* distributed.
@@ -59,7 +57,6 @@ public enum Classification {
/**
* Private classification level.
*
* <p>
* Indicates that the calendar content is private and should not be shared
* with others.
@@ -68,7 +65,6 @@ public enum Classification {
/**
* Confidential classification level.
*
* <p>
* Indicates that the calendar content is confidential and should be kept
* strictly private.
@@ -79,8 +75,6 @@ public enum Classification {
/**
* -- GETTER --
* Get the string representation of the classification level.
*
* @return the string representation of the classification level
*/
private final String classification;
@@ -20,7 +20,6 @@
* the configuration and settings of the web calendar module. It provides
* various configurations and constants used in the generation and resolution
* of iCalendar content.
*
* <p>The classes in this package include:</p>
* <ul>
* <li>
@@ -19,7 +19,6 @@
* The package {@code cn.org.codecrafters.webcal} contains classes and modules
* related to web calendar generation and resolution. It provides functionality
* to create and manage iCalendar content for web-based calendar applications.
*
* <p>
* The main classes and modules in this package include:
* <ul>