Skip to content

#43 Add javadoc copyright footer and brand CSS - #60

Open
krh372 wants to merge 1 commit into
mainfrom
fix/43-javadoc-copyright-brand-css
Open

#43 Add javadoc copyright footer and brand CSS#60
krh372 wants to merge 1 commit into
mainfrom
fix/43-javadoc-copyright-brand-css

Conversation

@krh372

@krh372 krh372 commented Aug 21, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Javadoc previously had no copyright notice and used the plain default styling.
  • Added a bottom footer to the root maven-javadoc-plugin config: "Copyright (c) {currentYear} Namazu Studios LLC. All rights reserved." (applies to every module since the plugin is configured once at the root).
  • Added src/main/javadoc/stylesheet.css with brand colors (hot pink #FF0099, navy #0D1335) applied via the raw -stylesheetfile javadoc option (Maven's own addStylesheets/stylesheetfile parameters only resolve paths relative to each module's own src/main/javadoc/, which doesn't work for a single shared file across an 84-module reactor).
  • Fixed a contrast issue found during review: non-link text in the nav bars (e.g. "Package", "Class" breadcrumb labels) and the active class-summary tab button were dark text on the new navy background. Explicit white text color added for nav bars and the active tab.

Test plan

  • Generated javadoc for sdk-model locally (mvn -pl sdk-model javadoc:javadoc) and visually confirmed:
    • Copyright footer appears on every page
    • Brand CSS colors applied (navy nav bars, hot pink links/tabs)
    • Nav bar text and active-tab text are readable (white on navy) after the contrast fix

Closes #43

@ptwohig
ptwohig self-requested a review August 21, 2026 02:43
@ptwohig

ptwohig commented Aug 21, 2026

Copy link
Copy Markdown
Contributor

You should give this one a visual pass. I tried to apply it to Crossfire's javadocs and it looked terrible. If the text is hot pink it's a bit much unless we make the whole page navy.

@ptwohig ptwohig left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like it got wrecked - https://apidocs.namazustudios.com/?product=elements&version=3.9.0-SNAPSHOT-0f25e2102&uri=javadoc%2Findex.html

Need to fiddle with the CSS to get it looking better.

@krh372

krh372 commented Aug 22, 2026

Copy link
Copy Markdown
Collaborator Author

@ptwohig Is there a way to test this with your CSS additions to make sure there are no conflicts?

@ptwohig

ptwohig commented Aug 25, 2026

Copy link
Copy Markdown
Contributor

@krh372 Every push you make to any branch will result in the docs being deployed to the site. So you can review it there. Unfortunately, it takes a whole build to do that.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Javadoc missing copyright company name and brand CSS

2 participants