Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Organize project into a reusable library #43

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ctubbsii
Copy link
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.

* 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 self-assigned this Jul 24, 2024
@ctubbsii
Copy link
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.

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