thischwa/CloudflareDNS-java
1
0
Fork 0
Code Issues Pull Requests Actions Packages Releases 1 Activity

Add Javadoc generation scripts and enhance README examples

Browse Source 
Introduce Javadoc-related files (`javadoc.sh`, `options`, and `packages`) for API documentation generation. Update README to improve clarity on usage examples and remove redundant "Example" headings for a cleaner presentation.
This commit is contained in:
Thilo Schwarz
2025-03-23 13:12:45 +01:00
parent 042678a6d7
commit 30ffb7c4b4
4 changed files with 45 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/apidocs/javadoc.sh
Executable
+1
View File
@@ -0,0 +1 @@
/Users/thilo/.sdkman/candidates/java/21.0.4-amzn/bin/javadoc @options @packages
docs/apidocs/options
+24
View File
@@ -0,0 +1,24 @@
-classpath
'/Users/thilo/.m2/repository/org/apache/httpcomponents/client5/httpclient5/5.4.2/httpclient5-5.4.2.jar:/Users/thilo/.m2/repository/org/apache/httpcomponents/core5/httpcore5/5.3.3/httpcore5-5.3.3.jar:/Users/thilo/.m2/repository/org/apache/httpcomponents/core5/httpcore5-h2/5.3.3/httpcore5-h2-5.3.3.jar:/Users/thilo/.m2/repository/org/slf4j/slf4j-api/1.7.36/slf4j-api-1.7.36.jar:/Users/thilo/.m2/repository/org/projectlombok/lombok/1.18.36/lombok-1.18.36.jar:/Users/thilo/.m2/repository/com/fasterxml/jackson/core/jackson-databind/2.18.2/jackson-databind-2.18.2.jar:/Users/thilo/.m2/repository/com/fasterxml/jackson/core/jackson-annotations/2.18.2/jackson-annotations-2.18.2.jar:/Users/thilo/.m2/repository/com/fasterxml/jackson/core/jackson-core/2.18.2/jackson-core-2.18.2.jar:/Users/thilo/.m2/repository/com/fasterxml/jackson/datatype/jackson-datatype-jsr310/2.18.2/jackson-datatype-jsr310-2.18.2.jar:/Users/thilo/.m2/repository/ch/qos/logback/logback-classic/1.5.12/logback-classic-1.5.12.jar:/Users/thilo/.m2/repository/ch/qos/logback/logback-core/1.5.12/logback-core-1.5.12.jar:/Users/thilo/.m2/repository/org/jetbrains/annotations/24.0.0/annotations-24.0.0.jar'
-encoding
'UTF-8'
-protected
-source
'17'
-sourcepath
'/Users/thilo/development/java/CloudflareDNS-java/src/main/java'
-author
-bottom
'Copyright © 2025. All rights reserved.'
-charset
'UTF-8'
-d
'/Users/thilo/development/java/CloudflareDNS-java/docs/apidocs'
-docencoding
'UTF-8'
-doctitle
'CloudflareDNS-java 0.1.0-SNAPSHOT API'
-use
-version
-windowtitle
'CloudflareDNS-java 0.1.0-SNAPSHOT API'
docs/apidocs/packages
+2
View File
@@ -0,0 +1,2 @@
codes.thischwa.cf
codes.thischwa.cf.model