Skip to content

Commit fa3974b

Browse files
committed
Fix javadoc generation and some errors
- Generate javadoc containing all the classes from all submodules
1 parent f787b37 commit fa3974b

5 files changed

Lines changed: 21 additions & 5 deletions

File tree

.travis.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
language: java
22

33
script: ./gradlew check
4-
after_success: ./gradlew javadoc
4+
after_success: ./gradlew aggregatedJavadocs
55

66
deploy:
77
provider: pages

build.gradle

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,3 +29,19 @@ subprojects {
2929
}
3030
}
3131

32+
// https://discuss.gradle.org/t/best-approach-gradle-multi-module-project-generate-just-one-global-javadoc/18657/21
33+
task aggregatedJavadocs(type: Javadoc, group: 'Documentation') {
34+
destinationDir = file("$buildDir/docs/javadoc")
35+
title = "$project.name $version"
36+
// options.memberLevel = JavadocMemberLevel.PRIVATE
37+
options.links 'https://docs.oracle.com/javase/7/docs/api/'
38+
39+
subprojects.each { project ->
40+
project.tasks.withType(Javadoc).each { javadocTask ->
41+
source += javadocTask.source
42+
classpath += javadocTask.classpath
43+
excludes += javadocTask.excludes
44+
includes += javadocTask.includes
45+
}
46+
}
47+
}

extractor/src/main/java/org/schabi/newpipe/extractor/Extractor.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
public abstract class Extractor {
1111
/**
12-
* {@link StreamingService} currently related to this extractor.<br/>
12+
* {@link StreamingService} currently related to this extractor.<br>
1313
* Useful for getting other things from a service (like the url handlers for cleaning/accepting/get id from urls).
1414
*/
1515
private final StreamingService service;
@@ -20,7 +20,7 @@ public abstract class Extractor {
2020
* What makes a url "dirty" or not is, for example, the additional parameters
2121
* (not important as—in this case—the id):
2222
* <pre>
23-
* https://www.youtube.com/watch?v=a9Zf_258aTI<i>&t=4s</i> → <i><b>&t=4s</b></i>
23+
* https://www.youtube.com/watch?v=a9Zf_258aTI<i>&amp;t=4s</i> → <i><b>&amp;t=4s</b></i>
2424
* </pre>
2525
* But as you can imagine, the time parameter is very important when calling {@link org.schabi.newpipe.extractor.stream.StreamExtractor#getTimeStamp()}.
2626
*/

extractor/src/main/java/org/schabi/newpipe/extractor/ListExtractor.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ public ListExtractor(StreamingService service, String url) {
2626
public abstract InfoItemsPage<R> getInitialPage() throws IOException, ExtractionException;
2727

2828
/**
29-
* Returns an url that can be used to get the next page relative to the initial one.<br/>
29+
* Returns an url that can be used to get the next page relative to the initial one.
3030
* <p>Usually, these links will only work in the implementation itself.</p>
3131
*
3232
* @return an url pointing to the next page relative to the initial page

extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/YoutubeStreamUrlIdHandler.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ public String getId(String url) throws ParsingException, IllegalArgumentExceptio
119119
* Shared URI's look like this:
120120
* <pre>
121121
* * https://www.youtube.com/shared?ci=PJICrTByb3E
122-
* * vnd.youtube://www.youtube.com/shared?ci=PJICrTByb3E&feature=twitter-deep-link
122+
* * vnd.youtube://www.youtube.com/shared?ci=PJICrTByb3E&amp;feature=twitter-deep-link
123123
* </pre>
124124
*
125125
* @param url The shared url

0 commit comments

Comments
 (0)