Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Javadoc/Groovydoc generation #83

Open
etatara opened this issue Dec 20, 2022 · 2 comments
Open

Javadoc/Groovydoc generation #83

etatara opened this issue Dec 20, 2022 · 2 comments
Assignees

Comments

@etatara
Copy link
Member

etatara commented Dec 20, 2022

Groovydoc generation requires Groovy SDK 2.5 and does not work with Java17. The current toolchain and instructions for building the API docs is generally over-complex and should be streamlined to work with Java 17+ and Groovy SDK 3/4.

The Repast javadoc will build OK with Java 17, so it may just be a matter of updating the Groovydoc generation.

@etatara etatara self-assigned this Dec 20, 2022
@etatara
Copy link
Member Author

etatara commented Jun 11, 2024

Some findings during the RS 2.11 release:

  • JDK 17 using groovy SDK 3.0.21 generates the groovydoc OK. I updated the groovydoc XML ant task to reflect this. However, the RelogoReferenceCreator.groovy that generates the RelogoPrimitives.html will fail when using groovydoc producted from groovy 3.x. This is because the HTML references in the ver 3.x groovydoc are different from the HTML references produced in groovy 2.5.x
  • JDK 17 using groovy SDK 2.5.23 (released 8-2023) generates groovydocs OK and the RelogoReferenceCreator produces the correct RelogoPrimitives.

@etatara
Copy link
Member Author

etatara commented Jun 11, 2024

Made some improvements to the build javadoc and groovydoc ant scripts to reduce manual burden of generating the docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant