Skip to content

build!: use same parent POM for all modules, and fix javadoc inter-module linking#538

Merged
baltzell merged 8 commits intodevelopmentfrom
aggregate-javadoc
May 9, 2025
Merged

build!: use same parent POM for all modules, and fix javadoc inter-module linking#538
baltzell merged 8 commits intodevelopmentfrom
aggregate-javadoc

Conversation

@c-dilks
Copy link
Member

@c-dilks c-dilks commented Apr 7, 2025 •
edited
Loading

Important

The front page of the API documentation will look quite different

  • If you're confused by this, try 'SEARCH', 'INDEX', or 'TREE' at the top of the page
  • Many links are now being auto-generated, which should make the documentation significantly easier to navigate

  • follows up on build!: various cleanups #515 by making parent/pom.xml be the parent POM for everyone

    • only common-tools/cnuphys is affected, since those modules were using common-tools/cnuphys/parent/pom.xml as their parent POM, which was pretty much a "subset" of parent/pom.xml
    • removed a couple more unused pom.xml files (in common-tools/cnuphys)
    • adds XML preamble to all pom.xml files that lacked it

  • fixes Javadoc multi project/subproject strucuture #536 by aggregating javadoc results

    • many more links are now being auto-generated
    • the front "overview" page is now generated by javadoc, instead of some HTML generation
    • the version number is now included in the documentation webpage title

  • build-javadocs.sh is ⚠️ removed and replaced by build-coatjava.sh --docs

    • documentation is now "installed" to coatjava/share/doc/coatjava/html/, which is more consistent with the Filesystem Hierarchy Standard (man hier)
      • previous location docs/javadoc is now fully git ignored
    • CI configs updated accordingly; modified GitLab config is ⚠️ not tested with this PR, but should be trivial to fix if it doesn't work

@c-dilks c-dilks force-pushed the aggregate-javadoc branch from 136e621 to 1574cc3 Compare April 7, 2025 14:26
@c-dilks c-dilks linked an issue Apr 7, 2025 that may be closed by this pull request
Javadoc multi project/subproject strucuture #536
Closed
baltzell
baltzell previously approved these changes Apr 7, 2025
View reviewed changes
@c-dilks c-dilks changed the title fix(javadoc): inter-module linking build!: use same parent POM for all modules, and fix javadoc inter-module linking Apr 7, 2025
@c-dilks
Copy link
Member Author

c-dilks commented Apr 7, 2025

Here's a sample deployment from my fork: https://c-dilks.github.io/coatjava/javadoc/index.html

@c-dilks c-dilks mentioned this pull request Apr 7, 2025
Closed
@c-dilks
Copy link
Member Author

c-dilks commented May 2, 2025

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.

@c-dilks c-dilks mentioned this pull request May 2, 2025
Merged
@baltzell
Copy link
Collaborator

baltzell commented May 5, 2025

After this, we can do #612

Base automatically changed from one-version-num to development May 9, 2025 20:16
@baltzell baltzell dismissed their stale review May 9, 2025 20:16

The base branch was changed.

c-dilks added 7 commits May 9, 2025 17:38
@c-dilks
build: aggregate javadoc
7f39bcf
@c-dilks
fix: some progress...
61917ce
@c-dilks
fix: make sure all pom.xmls have a preamble
478a963
@c-dilks
build!: use the main parent POM for common-tools/cnuphys
02279e1 
- 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
@c-dilks
feat: use build-coatjava.sh to build documentation
4fb1806
@c-dilks
fix: ignore docs/javadoc files
fd397a4 
for those who have generated them locally
@c-dilks
fix: cleanup
38149a3
@c-dilks c-dilks force-pushed the aggregate-javadoc branch from 2327433 to 38149a3 Compare May 9, 2025 21:42
@c-dilks c-dilks marked this pull request as ready for review May 9, 2025 21:59
@baltzell baltzell merged commit ecd4219 into development May 9, 2025
30 checks passed
@baltzell baltzell deleted the aggregate-javadoc branch May 9, 2025 22:13
c-dilks added a commit that referenced this pull request Sep 15, 2025
@c-dilks
build!: use same parent POM for all modules, and fix javadoc inter-…
383f8aa 
…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
@c-dilks @tongtongcao
build!: use same parent POM for all modules, and fix javadoc inter-…
201a8bb 
…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
@c-dilks @tongtongcao
build!: use same parent POM for all modules, and fix javadoc inter-…
52e21e2 
…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
@c-dilks @tongtongcao
build!: use same parent POM for all modules, and fix javadoc inter-…
bea080e 
…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
@c-dilks @tongtongcao
build!: use same parent POM for all modules, and fix javadoc inter-…
7336c55 
…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
@c-dilks @tongtongcao
build!: use same parent POM for all modules, and fix javadoc inter-…
9f4d016 
…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
@c-dilks @tongtongcao
build!: use same parent POM for all modules, and fix javadoc inter-…
8bf14e4 
…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

Reviewers

@baltzell baltzell baltzell approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Javadoc multi project/subproject strucuture

2 participants

@c-dilks @baltzell