Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

build(gradle): javadoc enhance + namings migration #473

Merged
merged 15 commits into from
Dec 15, 2021
Merged

build(gradle): javadoc enhance + namings migration #473

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
0bf68a1
docs(javadoc): Grouping packages into specific modules
stachu540 Dec 2, 2021
a536463
fix(javadoc): fixing html typings in compilation javadoc
stachu540 Dec 3, 2021
05ad5cf
build(gradle): move `artifactId` names to `base.archivesName`
stachu540 Dec 3, 2021
d9d0153
build(gradle): enhance javadoc
stachu540 Dec 3, 2021
cccd070
build(gradle): redact to DSL
stachu540 Dec 3, 2021
d0ab734
build(gradle): add overview files
stachu540 Dec 5, 2021
ebc05e1
build(gradle): localize to english
stachu540 Dec 5, 2021
ca53096
build(gradle): use task only if JVM version is 9+
stachu540 Dec 5, 2021
366f8a3
build(gradle): migrate module namings into settings.gradle.kts
stachu540 Dec 5, 2021
5d81efb
fix: update overview-*.html
stachu540 Dec 7, 2021
ace10af
docs: update javadocs templates / reorder groups
PhilippHeuer Dec 8, 2021
b84c298
fix: wrong package name for tmi
PhilippHeuer Dec 8, 2021
1ea0cf8
docs: update docs link in overview-general.html
PhilippHeuer Dec 8, 2021
8a8f805
docs: update docs link in overview-single.html
PhilippHeuer Dec 8, 2021
5824a38
docs: link to aggregated javadoc should be in overview-single.html
PhilippHeuer Dec 8, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
11 changes: 4 additions & 7 deletions build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,19 +217,16 @@ tasks.register<Javadoc>("aggregateJavadoc") {
this as StandardJavadocDocletOptions
overview = file("${rootDir}/buildSrc/overview-general.html").absolutePath
group("Common", "com.github.twitch4j.common*")
group("Core", "com.github.twitch4j", "com.github.twitch4j.domain*", "com.github.twitch4j.events*", "com.github.twitch4j.modules*")
group("Auth", "com.github.twitch4j.auth*")
group("Chat", "com.github.twitch4j.chat*")
group("EventSub", "com.github.twitch4j.eventsub*")
group("GraphQL", "com.github.twitch4j.graphql*")
group("PubSub", "com.github.twitch4j.pubsub*")
group("Helix API", "com.github.twitch4j.helix*")
group("Twitch Message Interface - API", "com.github.twitch4j.tmi*")
group("GraphQL", "com.github.twitch4j.graphql*")
group("Extensions API", "com.github.twitch4j.extensions*")
group("New API - Helix", "com.github.twitch4j.helix*")
group("Kraken API v5 (deprecated)", "com.github.twitch4j.kraken*")
group("Twitch Message Interface - API", "com.github.twitch4j.tmi*")
group("Core",
"com.github.twitch4j", "com.github.twitch4j.domain*",
"com.github.twitch4j.events*", "com.github.twitch4j.modules*"
)
addBooleanOption("html5").setValue(true)
}

Expand Down
78 changes: 5 additions & 73 deletions buildSrc/overview-general.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,79 +1,11 @@
<html lang="en">
<body>
<p style="text-align: center">
<a href="https://twitch4j.github.io">
<img alt="Twitch4J Logo" height="256" src="https://twitch4j.github.io/assets/images/logo.svg">
</a>
</p>
<h1 style="text-align: center">Welcome to the Twitch4J Javadoc Documentation</h1>
<table style="border: 1px solid #000; margin-left: auto; margin-right: auto">
<caption style="padding-bottom: 6px">All packages have a specific groups contained into each module</caption>
<tr>
<th>Package name</th>
<th>Group Name</th>
</tr>
<tr>
<td style="float: right"><code>twitch4j-common</code></td>
<td>Common</td>
</tr>
<tr>
<td style="float: right"><code>twitch4j-auth</code></td>
<td>Auth</td>
</tr>
<tr>
<td style="float: right"><code>twitch4j-chat</code></td>
<td>Chat</td>
</tr>
<tr>
<td style="float: right"><code>twitch4j-eventsub-common</code></td>
<td>EventSub</td>
</tr>
<tr>
<td style="float: right"><code>twitch4j-graphql</code></td>
<td>GraphQL</td>
</tr>
<tr>
<td style="float: right"><code>twitch4j-pubsub</code></td>
<td>PubSub</td>
</tr>
<tr>
<td style="float: right"><code>twitch4j-extensions</code></td>
<td>Extensions API</td>
</tr>
<tr>
<td style="float: right"><code>twitch4j-helix</code></td>
<td>New API - Helix</td>
</tr>
<tr>
<td style="float: right"><code>twitch4j-kraken</code></td>
<td>Kraken API v5 <sup>(deprecated)</sup></td>
</tr>
<tr>
<td style="float: right"><code>twitch4j-messageinterface</code></td>
<td>Twitch Message Interface - API</td>
</tr>
<tr>
<td style="float: right"><code>twitch4j</code></td>
<td>Core</td>
</tr>
</table>
<h2>To getting started please refer to our documentation</h2>
<p><img alt="Twitch4J Logo" width="64" height="64" src="https://twitch4j.github.io/assets/images/logo.svg"/></p>
<p>Check out our documentation at <a href="https://twitch4j.github.io/">twitch4j.github.io</a></p>
PhilippHeuer marked this conversation as resolved.
Show resolved Hide resolved
<ul>
<li><a href="#">Getting Started</a></li>
<li><a href="#">Basics Usage</a></li>
<li><a style="text-decoration: line-through" href="#">Android Compatibility</a> <sup>(in
progress)</sup></li>
<li><a href="#">Minecraft Plugin</a></li>
</ul>
<h2>Thank you to our sponsors to provide open-source developing tools</h2>
<ul>
<li>
<a href="https://www.jetbrains.com/">JetBrains</a> - for providing <a
href="https://www.jetbrains.com/idea/">IntelliJ IDEA</a></li>
<li>
<a href="https://www.yourkit.com/">YourKit</a> - for providing <a
href="https://www.yourkit.com/java/profiler/">Java Profiler</a> for Performance Tuning
</li>
<li><a href="https://twitch4j.github.io/javadoc">Aggregated Javadocs (all modules)</a></li>
PhilippHeuer marked this conversation as resolved.
Show resolved Hide resolved
<li><a href="https://twitch4j.github.io/docs/getting-started/installation/">Installation</a></li>
<li><a href="https://twitch4j.github.io/docs/getting-started/client-builder/">Usage</a></li>
</ul>
</body>
</html>
28 changes: 4 additions & 24 deletions buildSrc/overview-single.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,30 +1,10 @@
<html lang="en">
<body>
<p style="text-align: center">
<a href="https://twitch4j.github.io">
<img alt="Twitch4J Logo" width="128" height="128" src="https://twitch4j.github.io/assets/images/logo.svg"/>
</a>
</p>
<h1 style="text-align: center">Welcome to the Twitch4J Javadoc Documentation</h1>
<p style="text-align: center">This javadoc is a partial of the full documentation hosted into <a href="https://twitch4j.github.io/javadoc">official
website</a></p>
<h2>To getting started please refer to our documentation</h2>
<p><img alt="Twitch4J Logo" width="64" height="64" src="https://twitch4j.github.io/assets/images/logo.svg"/></p>
<p>Check out our documentation at <a href="https://twitch4j.github.io/">twitch4j.github.io</a></p>
PhilippHeuer marked this conversation as resolved.
Show resolved Hide resolved
<ul>
<li><a href="#">Getting Started</a></li>
<li><a href="#">Basics Usage</a></li>
<li><a style="text-decoration: line-through" href="#">Android Compatibility</a> <sup>(in
progress)</sup></li>
<li><a href="#">Minecraft Plugin</a></li>
</ul>
<h2>Thank you to our sponsors to provide open-source developing tools</h2>
<ul>
<li>
<a href="https://www.jetbrains.com/">JetBrains</a> - for providing <a
href="https://www.jetbrains.com/idea/">IntelliJ IDEA</a></li>
<li>
<a href="https://www.yourkit.com/">YourKit</a> - for providing <a
href="https://www.yourkit.com/java/profiler/">Java Profiler</a> for Performance Tuning
</li>
<li><a href="https://twitch4j.github.io/docs/getting-started/installation/">Installation</a></li>
<li><a href="https://twitch4j.github.io/docs/getting-started/client-builder/">Usage</a></li>
</ul>
</body>
</html>