search

PiggyPiglet / DocDex

JSON API & Discord Bot for Javadocs
https://docdex.helpch.at
MIT License
34 stars 9 forks source link

Javadoc List #14

Open PiggyPiglet opened 3 years ago

PiggyPiglet commented 3 years ago

Javadocs hosted by the official docdex instance, https://docdex.helpch.at & https://piggypiglet.me/docdex. Please request new javadocs here, by leaving the name, and a link to the javadoc jar (preferably from a maven repo). I need the jar as these docs are hosted locally. I'll react to your message with a thumbs up when I've added your javadoc.

conclube commented 3 years ago

jdk 11, as of now primary jdk is at version 8. But consider that java 8 has run out LTS non commercial and commercial it might be appropriate to bump the primary version up to 11 which currently is LTS or at least add it.

MiniDigger commented 3 years ago

bungee/bungee chat

PiggyPiglet commented 3 years ago

bungee/bungee chat

bungee chat is already there, I just named it badly (was "chat"). I've added bungeecord & waterfall to the todo list

Laarryy commented 3 years ago

cloud :3 https://javadoc.commandframework.cloud/ https://github.com/Incendo/cloud

PiggyPiglet commented 3 years ago

cloud :3 https://javadoc.commandframework.cloud/ https://github.com/Incendo/cloud

Do you have, or know how to generate a singular javadoc jar for all of cloud's subprojects? Otherwise there'll be 69 different javadocs for cloud: cloud, cloud-annotations, cloud-bukkit, cloud-bungeecord, etc

EDIT: such information would also be useful for other projects such as bungee & waterfall which also have lots of subprojects EDIT 2: Cloud author uses this snippet to generate them,

task aggregatedJavadocs(type: Javadoc, description: "Generate javadocs from all child projects as if it was a single project", group: "Documentation") {
    destinationDir = file("./docs/javadoc")
    title = "$project.name $version API"
    options.author true
    options.links "http://docs.spring.io/spring/docs/4.3.x/javadoc-api/", "http://docs.oracle.com/javase/8/docs/api/", "http://docs.spring.io/spring-ws/docs/2.3.0.RELEASE/api/", "http://docs.spring.io/spring-security/site/docs/4.0.4.RELEASE/apidocs/"
    options.addStringOption("Xdoclint:none", "-quiet")

    delete("./docs")

    subprojects.each { proj ->
        proj.tasks.withType(Javadoc).each { javadocTask ->
            source += javadocTask.source
            classpath += javadocTask.classpath
            excludes += javadocTask.excludes
            includes += javadocTask.includes
        }
    }
}

This is just a note for myself

Andre601 commented 3 years ago

Not sure how much it would be used, but maybe add Javadocs of BKCommonLib, TrainCarts and maybe SignLink?

URLs (Javadoc)

I'm not sure if you need the pure javadoc jar, or if the normal jar is sufficient enough. If required will I ask Bergerkiller to update his CI to also build javadoc jars and let you know.

URLs (Jars)

PiggyPiglet commented 3 years ago

@Andre601 Yeah I need the javadoc jars sorry. If they're not on his ci, you might be able to find them on his repository, that's where I usually download them from.

Andre601 commented 3 years ago

@Andre601 Yeah I need the javadoc jars sorry. If they're not on his ci, you might be able to find them on his repository, that's where I usually download them from.

Would it help when BKCL and co have their javadoc jars on maven download? Could perhaps even be better considering that at least BKCL is updating a lot.

Berger probs won't add Javadoc jars to build since they would change extremely frequently.

PiggyPiglet commented 3 years ago

Would it help when BKCL and co have their javadoc jars on maven download? Could perhaps even be better considering that at least BKCL is updating a lot.

It's actually essential, as this is the basis of how auto updating will work. Mind linking me to the repository, and providing the relevant group/artifact ids?

Andre601 commented 3 years ago

The Maven repo does have different folders for each version, so I linked to the latest as of now. Jenkins does have the javadoc jars in the target folder, which should always be the latest.

BKCommonLib

TrainCarts

SignLink

PiggyPiglet commented 3 years ago

Thanks, I'll add them once I finish the auto updater.

dkim19375 commented 3 years ago

ProtocolLib: https://repo.dmulloy2.net/nexus/repository/releases/com/comphenix/protocol/ProtocolLib/4.2.1/ProtocolLib-4.2.1-javadoc.jar

Laarryy commented 3 years ago

As JDA is on here, I would much appreciate Javacord on here as well 😄

Javadoc jar available at https://github.com/Javacord/Javacord/releases/tag/v3.1.2 - let me know if you need anything else

PiggyPiglet commented 3 years ago

As JDA is on here, I would much appreciate Javacord on here as well

Javadoc jar available at https://github.com/Javacord/Javacord/releases/tag/v3.1.2 - let me know if you need anything else

Mind linking the maven repository, with the group/artifact id? The repository is more useful as it allows for auto updating the javadoc. If there isn't one though, or the javadocs aren't hosted on the repo, I'll use that link to add it soon.

Laarryy commented 3 years ago

groupID: org.javacord artifactID: javacord

central link: https://repo1.maven.org/maven2/org/javacord/

Laarryy commented 3 years ago

Request for AntiVPN-API at https://nexus.egg82.me/#browse/browse:maven-releases

groupID: me.egg82 artifactID: antivpn-api

conclube commented 3 years ago

Caffeine https://repo1.maven.org/maven2/com/github/ben-manes/caffeine/caffeine/

emilyy-dev commented 3 years ago

helper (main): https://repo1.maven.org/maven2/me/lucko/helper/ helper-sql: https://repo1.maven.org/maven2/me/lucko/helper-sql/

configurate-core: https://repo1.maven.org/maven2/org/spongepowered/configurate-core/ configurate-gson: https://repo1.maven.org/maven2/org/spongepowered/configurate-gson/ (also -json?) configurate-yaml: https://repo1.maven.org/maven2/org/spongepowered/configurate-yaml/ configurate-hocon: https://repo1.maven.org/maven2/org/spongepowered/configurate-hocon/

PiggyPiglet commented 3 years ago

ProtocolLib: https://repo.dmulloy2.net/nexus/repository/releases/com/comphenix/protocol/ProtocolLib/4.2.1/ProtocolLib-4.2.1-javadoc.jar

ProtocolLib doesn't publish the javadoc jars in newer releases, and while I've made an exception for spigot, paper, and the jdk (as these are still extremely prevalent), I don't think I want outdated plugins on the public instance.

The Maven repo does have different folders for each version, so I linked to the latest as of now. Jenkins does have the javadoc jars in the target folder, which should always be the latest.

BKCommonLib

TrainCarts

SignLink

These plugins' repository doesn't generate a maven-metadata.xml in the artifact's folder, so it is therefore incompatible with the auto updater as it's impossible to figure out which version is the latest. I've manually added the versions you linked, but future updates to the indexes for these plugins aren't guaranteed, unless the author starts automatically generating the maven-metadata.xml for their repo.

cloud :3 https://javadoc.commandframework.cloud/ https://github.com/Incendo/cloud

Still haven't added cloud because I don't really want to go to the hassle of forking the project, adding the snippet you gave me earlier, ensuring it's automatically synchronised with upstream, and setting up my personal jenkins instance to build the javadoc. I'll be more than happy to add cloud if the author adds a way to get the latest, full javadoc jar/zip. It doesn't necessarily have to be on a maven repo, it could for example just be a link. Adding another updating strategy to the auto updater (such as one that downloads from a mere link) isn't out of the question.

PiggyPiglet commented 3 years ago

groupID: org.javacord artifactID: javacord

central link: https://repo1.maven.org/maven2/org/javacord/

I added javacord-api btw, not javacord, as that artifact didn't have a javadoc jar.

ParadauxIO commented 3 years ago

Processing.org https://processing.github.io/processing-javadocs/core/

org.processing.core https://mvnrepository.com/artifact/org.processing/core/3.3.6

conclube commented 3 years ago

Jetbrains Annotations: https://repo1.maven.org/maven2/org/jetbrains/annotations/

Google Findbugs JSR305: https://repo1.maven.org/maven2/com/google/code/findbugs/jsr305/

BomBardyGamer commented 3 years ago

Add the Minestom API to the list of officially supported Javadocs

You can find the source here Or the published docs here

conclube commented 3 years ago

HikariCP: https://repo1.maven.org/maven2/com/zaxxer/HikariCP/4.0.3/

Lettuce: https://repo1.maven.org/maven2/io/lettuce/lettuce-core/6.1.1.RELEASE/

I definitively think the first one should be added, but the second one is my favorite redis4j lib and I would appreciate if it was added needless to say.

conclube commented 2 years ago

jdk17, I don't know where to find the sources jar but it would certainly be nice if jdk 17 was added and standardized due to it being yet another LTS version.

PiggyPiglet commented 2 years ago

jdk17, I don't know where to find the sources jar but it would certainly be nice if jdk 17 was added and standardized due to it being yet another LTS version.

Might be a little while till I can add 17 support unfortunately, as there's some changes in the javadoc html structure that requires changes in the parsing code, which I don't have time to make right now.