Added javadoc links

ical4j · Aug 17, 2024 · 6af55b3 · 6af55b3
1 parent ab04473
commit 6af55b3
Show file tree

Hide file tree

Showing 18 changed files with 36 additions and 0 deletions.
diff --git a/docs/command/index.md b/docs/command/index.md
@@ -1,5 +1,7 @@
 # iCal4j Command Line
 
+[[Javadoc]](https://javadoc.io/doc/org.ical4j/ical4j-command)
+
 A command framework for managing iCalendar and vCard data.
 
 [Download](https://files.ical4j.org/releases/ical4j-0.1.1-develop-SNAPSHOT.zip)

diff --git a/docs/components.md b/docs/components.md
@@ -1,5 +1,7 @@
 # iCalendar Components
 
+[[Javadoc]](https://javadoc.io/doc/org.mnode.ical4j/ical4j/latest/ical4j.core/net/fortuna/ical4j/model/component/package-summary.html)
+
 Components in iCalendar are used to encapsulate a group of properties (and subcomponents) that
 define a specific type of content. For example, events, to-dos and journals
 are all defined as components of an iCalendar object.

diff --git a/docs/connector/dav.md b/docs/connector/dav.md
@@ -1,3 +1,5 @@
 # iCal4j Connector - CalDAV/CardDAV
 
+[[Javadoc]](https://javadoc.io/doc/org.ical4j/ical4j-connector-dav)
+
 TBD.
diff --git a/docs/connector/index.md b/docs/connector/index.md
@@ -1,5 +1,7 @@
 # iCal4j Connector
 
+[[Javadoc]](https://javadoc.io/doc/org.ical4j/ical4j-connector-api)
+
 iCal4j Connector is a tool that helps you manage iCalendar and vCard collections.
 
 ![connector.mmd.svg](../images/connector.mmd.svg)

diff --git a/docs/connector/local.md b/docs/connector/local.md
@@ -1,4 +1,6 @@
 # iCal4j Connector - Local
 
+[[Javadoc]](https://javadoc.io/doc/org.ical4j/ical4j-connector-api/latest/ical4j.connector/org.ical4j.connector.local)
+
 Support for local filesystem storage of iCalendar and vCard objects.
 
diff --git a/docs/extensions/index.md b/docs/extensions/index.md
@@ -1,5 +1,7 @@
 # iCal4j Extensions
 
+[[Javadoc]](https://javadoc.io/doc/org.mnode.ical4j/ical4j-extensions)
+
 iCal4j Extensions is a Java library that provides support for widely used non-standard iCalendar objects (i.e. properties and parameters). These model extensions are implemented via the [object registry]]([ModelExtensions|custom) support in iCal4j.
 
 ## Usage

diff --git a/docs/filtering.md b/docs/filtering.md
@@ -1,5 +1,7 @@
 # iCal4j Filters
 
+[[Javadoc]](https://javadoc.io/doc/org.mnode.ical4j/ical4j/latest/ical4j.core/net/fortuna/ical4j/filter/package-summary.html)
+
 In addition to a robust and compliant implementation of the iCalendar specification, it is also important to have
 an expressive and powerful mechanism for accessing calendar data. iCal4j filters provide a framework for calendar
 object retrieval whether it be in-memory object models or some other data source.

diff --git a/docs/integration/email.md b/docs/integration/email.md
@@ -1,5 +1,7 @@
 # iCal4j Integration - Email
 
+[[Javadoc]](https://javadoc.io/doc/org.ical4j/ical4j-integration-mail)
+
 Email is typically used to implement the iCalendar iTIP scheduling specification for sharing and negotiating events
 such as meetings, etc.
 

diff --git a/docs/integration/index.md b/docs/integration/index.md
@@ -1,5 +1,7 @@
 # iCal4j Integration
 
+[[Javadoc]](https://javadoc.io/doc/org.ical4j/ical4j-integration-api)
+
 iCal4j Integration provides support for popular calendar message transports and tooling.
 
 ![integration.mmd.svg](../images/integration.mmd.svg)

diff --git a/docs/parameters.md b/docs/parameters.md
@@ -1,5 +1,7 @@
 # iCalendar Parameters
 
+[[Javadoc]](https://javadoc.io/doc/org.mnode.ical4j/ical4j/latest/ical4j.core/net/fortuna/ical4j/model/parameter/package-summary.html)
+
 The iCalendar specification defines parameters that may be added to properties to define metadata
 such as value type or classification.
 

diff --git a/docs/parser.md b/docs/parser.md
@@ -1,5 +1,7 @@
 # iCal4j Parser
 
+[[Javadoc]](https://javadoc.io/doc/org.mnode.ical4j/ical4j/latest/ical4j.core/net/fortuna/ical4j/data/package-summary.html)
+
 The iCal4j parsing functionality is designed to allow the use of alternate parser and content handler implementations.
 
 ![parsing.mmd.svg](images/parsing.mmd.svg)

diff --git a/docs/properties.md b/docs/properties.md
@@ -1,5 +1,7 @@
 # iCalendar Properties
 
+[[Javadoc]](https://javadoc.io/doc/org.mnode.ical4j/ical4j/latest/ical4j.core/net/fortuna/ical4j/model/property/package-summary.html)
+
 In the iCalendar specification properties are used to define features of iCalendar objects
 or components embedded within them (e.g. `VEVENT`, `VTIMEZONE`, etc.).
 

diff --git a/docs/serializer/index.md b/docs/serializer/index.md
@@ -1,5 +1,7 @@
 # iCal4j Serializer
 
+[[Javadoc]](https://javadoc.io/doc/org.ical4j/ical4j-serializer)
+
 Support for serialization of iCalendar objects to and from XML and JSON-based formats.
 
 ## Overview

diff --git a/docs/streams/index.md b/docs/streams/index.md
@@ -1,5 +1,7 @@
 # iCal4j Streams
 
+[[Javadoc]](https://javadoc.io/doc/org.ical4j/ical4j-streams)
+
 Reactive programming for iCalendar and vCard.
 
 ![streams.mmd.svg](../images/streams.mmd.svg)

diff --git a/docs/template/index.md b/docs/template/index.md
@@ -1,5 +1,7 @@
 # iCal4j Template
 
+[[Javadoc]](https://javadoc.io/doc/org.ical4j/ical4j-template)
+
 iCal4j Template provides prototypes for common iCalendar and vCard use-cases.
 
 ## Overview

diff --git a/docs/validation.md b/docs/validation.md
@@ -1,5 +1,7 @@
 # iCal4j Validation
 
+[[Javadoc]](https://javadoc.io/doc/org.mnode.ical4j/ical4j/latest/ical4j.core/net/fortuna/ical4j/validate/package-summary.html)
+
 iCal4j includes a comprehensive validation framework for checking compliance with the various iCalendar
 specifications. This framework may also be used to implement custom validation rules to support data validation
 for specific use-cases.

diff --git a/docs/vcard/index.md b/docs/vcard/index.md
@@ -1,5 +1,7 @@
 # iCal4j vCard
 
+[[Javadoc]](https://javadoc.io/doc/org.mnode.ical4j/ical4j-vcard)
+
 iCal4j vCard is a Java library that provides support for the vCard specification as defined by [draft-ietf-vcarddav-vcardrev-06](http://www.ietf.org/internet-drafts/draft-ietf-vcarddav-vcardrev-06.txt).
 
 ## Minimum requirements

diff --git a/docs/zoneinfo-outlook.md b/docs/zoneinfo-outlook.md
@@ -1,5 +1,7 @@
 # iCal4j ZoneInfo Outlook
 
+[[Javadoc]](https://javadoc.io/doc/org.mnode.ical4j/ical4j-zoneinfo-outlook)
+
 iCal4j ZoneInfo Outlook provides alternate timezone definitions that may provide greater compatibility with certain versions of Microsoft Outlook.
 
 ## Usage