mingness / processing-library-template

GNU General Public License v2.0
0 stars 1 forks source link

create javadoc output, and verify #6

Closed mingness closed 1 month ago

mingness commented 1 month ago

The gradle file currently doesn't create javadocs.

Tasks:

  1. Importing the java-library plugin, which adds a javadoc task.
  2. verify build/docs is as expected
enkatsu commented 1 month ago

I will start working on this issue first. Is /reference the correct directory for the Javadoc output?

mingness commented 1 month ago

Great! The default output for javadocs is in build/docs. The release tasks just need to copy the docs from where they are built into the release folder, and it currently assumes the docs are to be found in build/docs.

enkatsu commented 1 month ago

I understand 👌 I'll set up the javadoc task to output to the default directory.

mingness commented 1 month ago

Hi @enkatsu , I feel very embarassed. I should have updated the issue with more information. So, the java-library plugin will actually create a javadoc task. So, I added the plugin as part of the the last PR, because the plugin adds some convenient configurations, like the compileOnly configuration, which I used for the Processing dependency. so, the repo already had a javadoc task. I just wasn't sure if the output was correct / fit for the job. So, I guess the first task for the issue was check if the javadoc task built into the java-library plugin worked well already.

enkatsu commented 1 month ago

Hi @mingness , I'm sorry for jumping to conclusions. Thank you for the detailed explanation 🙏 I understand now that I should have checked whether the existing javadoc task works correctly for the Processing library. I've only done some basic tests so far, so I will test it thoroughly and report back on how it works.

enkatsu commented 1 month ago

Hello @mingness , I conducted two tests regarding JavaDoc generation with ./gradlew javadoc. The first test was creating a class within the com.example package to see if it would be reflected in the JavaDoc. The second test involved using a dependent third-party library to check if the documentation would be generated correctly. Both tests seemed to generate the appropriate documentation, so please check the screenshots.

Does this approach look good to you? Also, if there are any other test items that should be checked, I would appreciate your advice 🙏

Screenshot 2024-07-30 at 23-18-19 com example (HelloLibrary 1 0-SNAPSHOT API) Screenshot 2024-07-30 at 23-18-09 TestClass (HelloLibrary 1 0-SNAPSHOT API) Screenshot 2024-07-30 at 23-17-53 HelloLibrary (HelloLibrary 1 0-SNAPSHOT API)

mingness commented 1 month ago

Thanks, that looks good to me :pray: I would say job done.