Fix javadoc generation and some errors
- Generate javadoc containing all the classes from all submodules
This commit is contained in:
parent
f787b375e5
commit
fa3974bf3a
|
@ -1,7 +1,7 @@
|
||||||
language: java
|
language: java
|
||||||
|
|
||||||
script: ./gradlew check
|
script: ./gradlew check
|
||||||
after_success: ./gradlew javadoc
|
after_success: ./gradlew aggregatedJavadocs
|
||||||
|
|
||||||
deploy:
|
deploy:
|
||||||
provider: pages
|
provider: pages
|
||||||
|
|
16
build.gradle
16
build.gradle
|
@ -29,3 +29,19 @@ subprojects {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// https://discuss.gradle.org/t/best-approach-gradle-multi-module-project-generate-just-one-global-javadoc/18657/21
|
||||||
|
task aggregatedJavadocs(type: Javadoc, group: 'Documentation') {
|
||||||
|
destinationDir = file("$buildDir/docs/javadoc")
|
||||||
|
title = "$project.name $version"
|
||||||
|
// options.memberLevel = JavadocMemberLevel.PRIVATE
|
||||||
|
options.links 'https://docs.oracle.com/javase/7/docs/api/'
|
||||||
|
|
||||||
|
subprojects.each { project ->
|
||||||
|
project.tasks.withType(Javadoc).each { javadocTask ->
|
||||||
|
source += javadocTask.source
|
||||||
|
classpath += javadocTask.classpath
|
||||||
|
excludes += javadocTask.excludes
|
||||||
|
includes += javadocTask.includes
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
|
@ -9,7 +9,7 @@ import java.io.IOException;
|
||||||
|
|
||||||
public abstract class Extractor {
|
public abstract class Extractor {
|
||||||
/**
|
/**
|
||||||
* {@link StreamingService} currently related to this extractor.<br/>
|
* {@link StreamingService} currently related to this extractor.<br>
|
||||||
* Useful for getting other things from a service (like the url handlers for cleaning/accepting/get id from urls).
|
* Useful for getting other things from a service (like the url handlers for cleaning/accepting/get id from urls).
|
||||||
*/
|
*/
|
||||||
private final StreamingService service;
|
private final StreamingService service;
|
||||||
|
@ -20,7 +20,7 @@ public abstract class Extractor {
|
||||||
* What makes a url "dirty" or not is, for example, the additional parameters
|
* What makes a url "dirty" or not is, for example, the additional parameters
|
||||||
* (not important as—in this case—the id):
|
* (not important as—in this case—the id):
|
||||||
* <pre>
|
* <pre>
|
||||||
* https://www.youtube.com/watch?v=a9Zf_258aTI<i>&t=4s</i> → <i><b>&t=4s</b></i>
|
* https://www.youtube.com/watch?v=a9Zf_258aTI<i>&t=4s</i> → <i><b>&t=4s</b></i>
|
||||||
* </pre>
|
* </pre>
|
||||||
* But as you can imagine, the time parameter is very important when calling {@link org.schabi.newpipe.extractor.stream.StreamExtractor#getTimeStamp()}.
|
* But as you can imagine, the time parameter is very important when calling {@link org.schabi.newpipe.extractor.stream.StreamExtractor#getTimeStamp()}.
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -26,7 +26,7 @@ public abstract class ListExtractor<R extends InfoItem> extends Extractor {
|
||||||
public abstract InfoItemsPage<R> getInitialPage() throws IOException, ExtractionException;
|
public abstract InfoItemsPage<R> getInitialPage() throws IOException, ExtractionException;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns an url that can be used to get the next page relative to the initial one.<br/>
|
* Returns an url that can be used to get the next page relative to the initial one.
|
||||||
* <p>Usually, these links will only work in the implementation itself.</p>
|
* <p>Usually, these links will only work in the implementation itself.</p>
|
||||||
*
|
*
|
||||||
* @return an url pointing to the next page relative to the initial page
|
* @return an url pointing to the next page relative to the initial page
|
||||||
|
|
|
@ -119,7 +119,7 @@ public class YoutubeStreamUrlIdHandler implements UrlIdHandler {
|
||||||
* Shared URI's look like this:
|
* Shared URI's look like this:
|
||||||
* <pre>
|
* <pre>
|
||||||
* * https://www.youtube.com/shared?ci=PJICrTByb3E
|
* * https://www.youtube.com/shared?ci=PJICrTByb3E
|
||||||
* * vnd.youtube://www.youtube.com/shared?ci=PJICrTByb3E&feature=twitter-deep-link
|
* * vnd.youtube://www.youtube.com/shared?ci=PJICrTByb3E&feature=twitter-deep-link
|
||||||
* </pre>
|
* </pre>
|
||||||
*
|
*
|
||||||
* @param url The shared url
|
* @param url The shared url
|
||||||
|
|
Loading…
Reference in New Issue