build!: use same parent POM for all modules, and fix javadoc inter-module linking
#538
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
c-dilks
force-pushed
the
aggregate-javadoc
branch
from
136e621 to
1574cc3
Compare
baltzell
previously approved these changes
Apr 7, 2025
c-dilks
changed the title
javadoc inter-module linking
Member
Author
|
Here's a sample deployment from my fork: https://c-dilks.github.io/coatjava/javadoc/index.html |
Member
Author
|
Just noticed that the Javadoc webpage size drops from ~160 MB down to ~9 MB. This is entirely because all the font resources are duplicated multiple times. |
Collaborator
|
After this, we can do #612 |
- fixes missing UTF-8 encoding bug by making sure that `common-tools/cnuphys/` POMs use the same `javadoc` config as everything else - a bit of scope creep here, since this is another "major" build change
for those who have generated them locally
baltzell
approved these changes
May 9, 2025
c-dilks
added a commit
that referenced
this pull request
Sep 15, 2025
…module linking (#538) * build: aggregate javadoc * fix: some progress... * fix: make sure all `pom.xml`s have a preamble * build!: use the main parent POM for `common-tools/cnuphys` - fixes missing UTF-8 encoding bug by making sure that `common-tools/cnuphys/` POMs use the same `javadoc` config as everything else - a bit of scope creep here, since this is another "major" build change * feat: use `build-coatjava.sh` to build documentation * fix: ignore `docs/javadoc` files for those who have generated them locally * fix: cleanup * fix: version num conflicts
tongtongcao
pushed a commit
that referenced
this pull request
Sep 22, 2025
…module linking (#538) * build: aggregate javadoc * fix: some progress... * fix: make sure all `pom.xml`s have a preamble * build!: use the main parent POM for `common-tools/cnuphys` - fixes missing UTF-8 encoding bug by making sure that `common-tools/cnuphys/` POMs use the same `javadoc` config as everything else - a bit of scope creep here, since this is another "major" build change * feat: use `build-coatjava.sh` to build documentation * fix: ignore `docs/javadoc` files for those who have generated them locally * fix: cleanup * fix: version num conflicts
tongtongcao
pushed a commit
that referenced
this pull request
Nov 18, 2025
…module linking (#538) * build: aggregate javadoc * fix: some progress... * fix: make sure all `pom.xml`s have a preamble * build!: use the main parent POM for `common-tools/cnuphys` - fixes missing UTF-8 encoding bug by making sure that `common-tools/cnuphys/` POMs use the same `javadoc` config as everything else - a bit of scope creep here, since this is another "major" build change * feat: use `build-coatjava.sh` to build documentation * fix: ignore `docs/javadoc` files for those who have generated them locally * fix: cleanup * fix: version num conflicts
tongtongcao
pushed a commit
that referenced
this pull request
Nov 21, 2025
…module linking (#538) * build: aggregate javadoc * fix: some progress... * fix: make sure all `pom.xml`s have a preamble * build!: use the main parent POM for `common-tools/cnuphys` - fixes missing UTF-8 encoding bug by making sure that `common-tools/cnuphys/` POMs use the same `javadoc` config as everything else - a bit of scope creep here, since this is another "major" build change * feat: use `build-coatjava.sh` to build documentation * fix: ignore `docs/javadoc` files for those who have generated them locally * fix: cleanup * fix: version num conflicts
tongtongcao
pushed a commit
that referenced
this pull request
Dec 5, 2025
…module linking (#538) * build: aggregate javadoc * fix: some progress... * fix: make sure all `pom.xml`s have a preamble * build!: use the main parent POM for `common-tools/cnuphys` - fixes missing UTF-8 encoding bug by making sure that `common-tools/cnuphys/` POMs use the same `javadoc` config as everything else - a bit of scope creep here, since this is another "major" build change * feat: use `build-coatjava.sh` to build documentation * fix: ignore `docs/javadoc` files for those who have generated them locally * fix: cleanup * fix: version num conflicts
tongtongcao
pushed a commit
that referenced
this pull request
Dec 5, 2025
…module linking (#538) * build: aggregate javadoc * fix: some progress... * fix: make sure all `pom.xml`s have a preamble * build!: use the main parent POM for `common-tools/cnuphys` - fixes missing UTF-8 encoding bug by making sure that `common-tools/cnuphys/` POMs use the same `javadoc` config as everything else - a bit of scope creep here, since this is another "major" build change * feat: use `build-coatjava.sh` to build documentation * fix: ignore `docs/javadoc` files for those who have generated them locally * fix: cleanup * fix: version num conflicts
tongtongcao
pushed a commit
that referenced
this pull request
Dec 31, 2025
…module linking (#538) * build: aggregate javadoc * fix: some progress... * fix: make sure all `pom.xml`s have a preamble * build!: use the main parent POM for `common-tools/cnuphys` - fixes missing UTF-8 encoding bug by making sure that `common-tools/cnuphys/` POMs use the same `javadoc` config as everything else - a bit of scope creep here, since this is another "major" build change * feat: use `build-coatjava.sh` to build documentation * fix: ignore `docs/javadoc` files for those who have generated them locally * fix: cleanup * fix: version num conflicts
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Important
The front page of the API documentation will look quite different
follows up on build!: various cleanups #515 by making
parent/pom.xmlbe the parent POM for everyonecommon-tools/cnuphysis affected, since those modules were usingcommon-tools/cnuphys/parent/pom.xmlas their parent POM, which was pretty much a "subset" ofparent/pom.xmlpom.xmlfiles (incommon-tools/cnuphys)pom.xmlfiles that lacked itfixes Javadoc multi project/subproject strucuture #536 by aggregating
javadocresultsjavadoc, instead of some HTML generationbuild-javadocs.shisbuild-coatjava.sh --docscoatjava/share/doc/coatjava/html/, which is more consistent with the Filesystem Hierarchy Standard (man hier)docs/javadocis now fullygitignored