Generating JavaDocs

Discussion in 'Spigot Plugin Development' started by HoLyCoW, Jun 19, 2016.

  1. From searching the forums, I found that I can generate the JavaDocs using the BuildTools and the --generate-docs parameter.

    However, it looks like it only generated javadocs for the Bukkit source. How can I build or where do I find the javadocs for the Spigot source?
     
  2. Choco

    Moderator

    ... erm... Spigot is a fork of Bukkit
     
    • Like Like x 1
  3. OP won't have docs for anything within Spigot subclass tho
     
    • Like Like x 2
    • Informative Informative x 1
  4. This I know.

    This is what I want.
     
    • Like Like x 1
  5. Open cmd prompt
    cd into Spigot API directory
    cd into src/main
    Code (Text):
    javadoc -d javadocs org.bukkit org.spigotmc
    I haven't tested this, not sure if it'll work
     
    • Like Like x 1
  6. Thanks, but didn't work. I get the following output:

    And that's from the <BuildTools Root>/Spigot/Spigot-API/src/main folder
     
    • Like Like x 1
  7. Tested this one.
    cd into the "java" folder under <BT root>/Spigot/Spigot-API/src/main
    and run this command:
    Code (Text):
    javadoc -d ../../../javadocs -subpackages org.bukkit org.spigotmc
    That'll generate the javadocs and plop them in <BT root>/Spigot/Spigot-API/javadocs
     
    • Useful Useful x 2
    • Like Like x 1
  8. Thank you. I appreciate you helping me with this. I get the following output with errors though.

    https://www.zerobin.net/?ee2718956a0a0217#5FYkM9phmQq2QFUMkBJ2cXYCiqhURqLxFk8DRUbDqUg=
     
    • Like Like x 1
    • Like Like x 1
  9. Thanks a lot Redrield.

    Just out of curiosity, is there a way to get them automatically generated when I run BuildTools with the --generate-docs parameter? Maybe with another parameter or so?
     
    • Like Like x 1
  10. You could modify BuildTools, but that might break things. Unless someone adds it you're stuck having to do it manually
     
    • Like Like x 1
    • Informative Informative x 1