docs: document IllegalStateException in DynamicTheme.initialize

[javier-godoy]

Close #147

Summary by CodeRabbit

• Documentation
  • Updated documentation to clarify exception handling when using legacy theme configuration.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 894738e9-172f-45c4-b83c-e862096988ab

📥 Commits

Reviewing files that changed from the base of the PR and between 2f2b5f2 and 2e49f2d.

📒 Files selected for processing (1)

• src/main/java/com/flowingcode/vaadin/addons/demo/DynamicTheme.java

---

Walkthrough

Updated Javadoc for DynamicTheme.initialize(IndexHtmlResponse) to document the thrown IllegalStateException when the active AppShellConfigurator uses the legacy @Theme annotation. No runtime logic changed.

Changes

Cohort / File(s)	Summary
DynamicTheme Javadoc src/main/java/com/flowingcode/vaadin/addons/demo/DynamicTheme.java	Added @throws IllegalStateException documentation to the initialize(IndexHtmlResponse) method Javadoc, documenting the exception thrown when a legacy @Theme-configured AppShellConfigurator is active.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• feat: add support for dynamic theme switching #140: Implements DynamicTheme initialization and adjusts AppShellConfigurator usage related to legacy @Theme handling.
• feat: support DynamicTheme initialization in multi-version add-ons #143: Adds/implements the initialize(IndexHtmlResponse) method that this PR documents exception behavior for.
• docs(readme): document DynamicTheme #141: Provides README documentation and examples for DynamicTheme initialization and removing legacy @Theme.

Suggested reviewers

• paodb
• mlopezFC

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and specifically describes the primary change: updating Javadoc documentation to document an IllegalStateException in the DynamicTheme.initialize method.
Linked Issues check	✅ Passed	The pull request directly addresses issue #147 by updating the Javadoc for DynamicTheme.initialize(IndexHtmlResponse) to document the IllegalStateException that can be thrown by the assertNotLegacyTheme() call.
Out of Scope Changes check	✅ Passed	All changes are scoped to updating Javadoc documentation for DynamicTheme.initialize; no unrelated code modifications were introduced outside the stated objective.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch fix-147

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud