Skip to content
This repository has been archived by the owner on Jun 23, 2023. It is now read-only.

Javadoc

Cyrus Chan edited this page Jan 6, 2022 · 2 revisions

Javadoc is a bundle with various of HTML files to describe every packages and classes with detailed explanations of usage. JOSEV provides both online and offline Javadoc for reference purpose.

Online JOSEV Javadoc

Official Javadoc GitHub repository

This actually is a official GitHub repository which pushed when new version of JOSEV package just has been released. The online version of official JOSEV Javadoc licenses is CC BY-ND 4.0 which you can share the document with attribution.

To ensure the content must be accreted from the source code, any content modification is forbidden (include but not limited to theme, JavaScript search function, content of classes and packages and page linking). If decide to publish modified JOSEV Javadoc, please uses offline Jar package instead.

Link: https://osp.rk0cc.xyz/javadoc/

javadoc.io

javadoc.io is a third party Javadoc hosting website which hosted on Maven Central. However, since it has around 30 minutes delay on release publicly on repository server, it may be outdated if new release published in a short period.

JOSEV packages Release page
josev-core javadoc
josev-pub javadoc

Offline JOSEV Javadoc

Jar file in release page

Providing Javadoc Jar file is mandatory when publish to Maven Central. This Jar file does not contains any Java source code but like a Zip file which contains HTML, CSS and JavaScript files of Javadoc.

This Javadoc does not come with any license which you can uses to modify content whatever you want without malicious purpose.

Every new version release of JOSEV packages provide Javadoc Jar file to download in GitHub's releases page.

JOSEV packages Release page
josev-core Link
josev-pub Link