Skip to content

Organize project into a reusable library - #43

Merged
ctubbsii merged 1 commit into
revelc:mainfrom
ctubbsii:api-improvements
Jul 15, 2026
Merged

Organize project into a reusable library#43
ctubbsii merged 1 commit into
revelc:mainfrom
ctubbsii:api-improvements

Conversation

@ctubbsii

Copy link
Copy Markdown
Member
  • Use {@code} in javadocs for maintainability
  • Replace some loops with functional code
  • Inline some trivial methods
  • Create flexible API for reporting type problems
  • Create separate ClassUtils for getting class info
  • Create separate PublicApi class for defining a public API to be analyzed
  • Separate analyzer code into its own Apilyzer class that takes a provided PublicApi and analyzes it independently of any Maven functionality. Separating the reponsibilities of different code components makes the code a bit more organized, and testable.

@ctubbsii ctubbsii added this to the 1.3.1 milestone Jul 24, 2024
@ctubbsii
ctubbsii requested a review from keith-turner July 24, 2024 02:08
@ctubbsii ctubbsii self-assigned this Jul 24, 2024
@ctubbsii

Copy link
Copy Markdown
Member Author

@keith-turner I had to update this project recently to fix the build with JDK 21 (see 925d716), and I ran across this old branch that I had forgotten about. I rebased and tested it, and it seems like it's a reasonable improvement to the code organization. Maybe not fully ready as a reusable library, but probably good enough that it can merge with the main branch.

* Use `{@code}` in javadocs for maintainability
* Replace some loops with functional code
* Inline some trivial methods
* Create flexible API for reporting type problems
* Create separate ClassUtils for getting class info
* Create separate PublicApi class for defining a public API to be
  analyzed
* Separate analyzer code into its own Apilyzer class that takes a
  provided PublicApi and analyzes it independently of any Maven
  functionality. Separating the reponsibilities of different code
  components makes the code a bit more organized, and testable.
* Use Java 17
@ctubbsii
ctubbsii merged commit 167513f into revelc:main Jul 15, 2026
3 checks passed
@ctubbsii
ctubbsii deleted the api-improvements branch July 15, 2026 17:55
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.

1 participant