Skip to content

Commit 0c3de8c

Browse files
committed
chore: update index.html files incl. javadoc versions
1 parent a62c14b commit 0c3de8c

29 files changed

+724
-1168
lines changed

javadoc/current/allclasses-index.html

Lines changed: 24 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,7 @@
2626
<div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button>
2727
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
2828
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
29-
<li><a href="index.html">Overview</a></li>
30-
<li>Package</li>
29+
<li><a href="io/github/thoroldvix/api/package-summary.html">Package</a></li>
3130
<li>Class</li>
3231
<li><a href="overview-tree.html">Tree</a></li>
3332
<li><a href="index-all.html">Index</a></li>
@@ -50,59 +49,55 @@
5049
<h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces</h1>
5150
</div>
5251
<div id="all-classes-table">
53-
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="all-classes-table-tab0" role="tab" aria-selected="true" aria-controls="all-classes-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="all-classes-table-tab1" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab1', 2)" class="table-tab">Interfaces</button><button id="all-classes-table-tab2" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab2', 2)" class="table-tab">Classes</button><button id="all-classes-table-tab3" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab3', 2)" class="table-tab">Enum Classes</button><button id="all-classes-table-tab5" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab5', 2)" class="table-tab">Exception Classes</button></div>
52+
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="all-classes-table-tab0" role="tab" aria-selected="true" aria-controls="all-classes-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="all-classes-table-tab1" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab1', 2)" class="table-tab">Interfaces</button><button id="all-classes-table-tab2" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab2', 2)" class="table-tab">Classes</button><button id="all-classes-table-tab5" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab5', 2)" class="table-tab">Exception Classes</button></div>
5453
<div id="all-classes-table.tabpanel" role="tabpanel" aria-labelledby="all-classes-table-tab0">
5554
<div class="summary-table two-column-summary">
5655
<div class="table-header col-first">Class</div>
5756
<div class="table-header col-last">Description</div>
58-
<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="io/github/thoroldvix/api/Transcript.html" title="interface in io.github.thoroldvix.api">Transcript</a></div>
59-
<div class="col-last even-row-color all-classes-table all-classes-table-tab1">
60-
<div class="block">Represents a single transcript for a YouTube video, including its metadata.</div>
57+
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="io/github/thoroldvix/api/BulkTranscriptRequest.html" title="class in io.github.thoroldvix.api">BulkTranscriptRequest</a></div>
58+
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
59+
<div class="block">Request object for retrieving transcripts.</div>
6160
</div>
62-
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/github/thoroldvix/internal/TranscriptApiFactory.html" title="class in io.github.thoroldvix.internal">TranscriptApiFactory</a></div>
61+
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/github/thoroldvix/api/Transcript.html" title="class in io.github.thoroldvix.api">Transcript</a></div>
6362
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
64-
<div class="block">Responsible for creating instances of <a href="io/github/thoroldvix/api/YoutubeTranscriptApi.html" title="interface in io.github.thoroldvix.api"><code>YoutubeTranscriptApi</code></a>.</div>
63+
<div class="block">Represents a single transcript for a YouTube video, including its metadata.</div>
64+
</div>
65+
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="io/github/thoroldvix/api/TranscriptApiFactory.html" title="class in io.github.thoroldvix.api">TranscriptApiFactory</a></div>
66+
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
67+
<div class="block">Responsible for creating instances of <a href="io/github/thoroldvix/api/YoutubeTranscriptApi.html" title="class in io.github.thoroldvix.api"><code>YoutubeTranscriptApi</code></a>.</div>
6568
</div>
66-
<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="io/github/thoroldvix/api/TranscriptContent.html" title="interface in io.github.thoroldvix.api">TranscriptContent</a></div>
67-
<div class="col-last even-row-color all-classes-table all-classes-table-tab1">
69+
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/github/thoroldvix/api/TranscriptContent.html" title="class in io.github.thoroldvix.api">TranscriptContent</a></div>
70+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
6871
<div class="block">Represents the content of a transcript for a single video.</div>
6972
</div>
70-
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="io/github/thoroldvix/api/TranscriptContent.Fragment.html" title="interface in io.github.thoroldvix.api">TranscriptContent.Fragment</a></div>
71-
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
73+
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="io/github/thoroldvix/api/TranscriptContent.Fragment.html" title="class in io.github.thoroldvix.api">TranscriptContent.Fragment</a></div>
74+
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
7275
<div class="block">Represents a single fragment of the transcript content.</div>
7376
</div>
74-
<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="io/github/thoroldvix/api/TranscriptFormatter.html" title="interface in io.github.thoroldvix.api">TranscriptFormatter</a></div>
75-
<div class="col-last even-row-color all-classes-table all-classes-table-tab1">
77+
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="io/github/thoroldvix/api/TranscriptFormatter.html" title="interface in io.github.thoroldvix.api">TranscriptFormatter</a></div>
78+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
7679
<div class="block">Represents a formatter for transcript content.</div>
7780
</div>
78-
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/github/thoroldvix/api/TranscriptFormatters.html" title="class in io.github.thoroldvix.api">TranscriptFormatters</a></div>
79-
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
81+
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="io/github/thoroldvix/api/TranscriptFormatters.html" title="class in io.github.thoroldvix.api">TranscriptFormatters</a></div>
82+
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
8083
<div class="block">Responsible for creating <a href="io/github/thoroldvix/api/TranscriptFormatter.html" title="interface in io.github.thoroldvix.api"><code>TranscriptFormatter</code></a> instances.</div>
8184
</div>
82-
<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="io/github/thoroldvix/api/TranscriptList.html" title="interface in io.github.thoroldvix.api">TranscriptList</a></div>
83-
<div class="col-last even-row-color all-classes-table all-classes-table-tab1">
84-
<div class="block">Represents a list of all available transcripts for a YouTube video.</div>
85-
</div>
86-
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/github/thoroldvix/api/TranscriptRequest.html" title="class in io.github.thoroldvix.api">TranscriptRequest</a></div>
85+
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/github/thoroldvix/api/TranscriptList.html" title="class in io.github.thoroldvix.api">TranscriptList</a></div>
8786
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
88-
<div class="block">Request object for retrieving transcripts.</div>
87+
<div class="block">Represents a list of all available transcripts for a YouTube video.</div>
8988
</div>
9089
<div class="col-first even-row-color all-classes-table all-classes-table-tab5"><a href="io/github/thoroldvix/api/TranscriptRetrievalException.html" title="class in io.github.thoroldvix.api">TranscriptRetrievalException</a></div>
9190
<div class="col-last even-row-color all-classes-table all-classes-table-tab5">
9291
<div class="block">Exception thrown when a transcript cannot be retrieved for a specified video.</div>
9392
</div>
9493
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="io/github/thoroldvix/api/YoutubeClient.html" title="interface in io.github.thoroldvix.api">YoutubeClient</a></div>
9594
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
96-
<div class="block">Responsible for sending GET requests to YouTube.</div>
95+
<div class="block">Responsible for sending GET and POST requests to YouTube.</div>
9796
</div>
98-
<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="io/github/thoroldvix/api/YoutubeTranscriptApi.html" title="interface in io.github.thoroldvix.api">YoutubeTranscriptApi</a></div>
99-
<div class="col-last even-row-color all-classes-table all-classes-table-tab1">
97+
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="io/github/thoroldvix/api/YoutubeTranscriptApi.html" title="class in io.github.thoroldvix.api">YoutubeTranscriptApi</a></div>
98+
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
10099
<div class="block">This is the main interface for the YouTube Transcript API.</div>
101100
</div>
102-
<div class="col-first odd-row-color all-classes-table all-classes-table-tab3"><a href="io/github/thoroldvix/api/YtApiV3Endpoint.html" title="enum class in io.github.thoroldvix.api">YtApiV3Endpoint</a></div>
103-
<div class="col-last odd-row-color all-classes-table all-classes-table-tab3">
104-
<div class="block">The YouTube API V3 endpoints.</div>
105-
</div>
106101
</div>
107102
</div>
108103
</div>

javadoc/current/allpackages-index.html

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,7 @@
2626
<div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button>
2727
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
2828
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
29-
<li><a href="index.html">Overview</a></li>
30-
<li>Package</li>
29+
<li><a href="io/github/thoroldvix/api/package-summary.html">Package</a></li>
3130
<li>Class</li>
3231
<li><a href="overview-tree.html">Tree</a></li>
3332
<li><a href="index-all.html">Index</a></li>
@@ -55,8 +54,6 @@ <h1 title="All&amp;nbsp;Packages" class="title">All&nbsp;Packages</h1>
5554
<div class="table-header col-last">Description</div>
5655
<div class="col-first even-row-color"><a href="io/github/thoroldvix/api/package-summary.html">io.github.thoroldvix.api</a></div>
5756
<div class="col-last even-row-color">&nbsp;</div>
58-
<div class="col-first odd-row-color"><a href="io/github/thoroldvix/internal/package-summary.html">io.github.thoroldvix.internal</a></div>
59-
<div class="col-last odd-row-color">&nbsp;</div>
6057
</div>
6158
</main>
6259
</div>

javadoc/current/element-list

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1 @@
11
io.github.thoroldvix.api
2-
io.github.thoroldvix.internal

javadoc/current/help-doc.html

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,7 @@
2626
<div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button>
2727
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
2828
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
29-
<li><a href="index.html">Overview</a></li>
30-
<li>Package</li>
29+
<li><a href="io/github/thoroldvix/api/package-summary.html">Package</a></li>
3130
<li>Class</li>
3231
<li><a href="overview-tree.html">Tree</a></li>
3332
<li><a href="index-all.html">Index</a></li>
@@ -70,7 +69,6 @@ <h1 class="title">JavaDoc Help</h1>
7069
</li>
7170
<li><a href="#help-pages">Kinds of Pages</a>:
7271
<ul class="help-subtoc">
73-
<li><a href="#overview">Overview</a></li>
7472
<li><a href="#package">Package</a></li>
7573
<li><a href="#class">Class or Interface</a></li>
7674
<li><a href="#doc-file">Other Files</a></li>
@@ -101,10 +99,6 @@ <h3>Search</h3>
10199
<div class="sub-title">
102100
<h2 id="help-pages">Kinds of Pages</h2>
103101
The following sections describe the different kinds of pages in this collection.
104-
<section class="help-section" id="overview">
105-
<h3>Overview</h3>
106-
<p>The <a href="index.html">Overview</a> page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.</p>
107-
</section>
108102
<section class="help-section" id="package">
109103
<h3>Package</h3>
110104
<p>Each package has a page that contains a list of its classes and interfaces, with a summary for each. These pages may contain the following categories:</p>

0 commit comments

Comments
 (0)