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

Tidy up post-refactoring analysis modules #3058

Open
IgnatBeresnev opened this issue Jul 4, 2023 · 0 comments
Open

Tidy up post-refactoring analysis modules #3058

IgnatBeresnev opened this issue Jul 4, 2023 · 0 comments
Assignees
Labels
epic A large body of work that is broken down into smaller issues language: Java Issue/PR related to the Java language feature/analysis/docs language: Kotlin Issue/PR related to the Kotlin language feature/analysis/docs tech-debt A technical issue that is not observable by the users, but improves maintainers quality of life

Comments

@IgnatBeresnev
Copy link
Member

IgnatBeresnev commented Jul 4, 2023

The refactoring done in #3034 uncovered a lot of difficult to comprehend code, as well as introduced more code / abstractions that are in themselves difficult to comprehend. The PR was merged into master prematurely to avoid having an enormous long-lived branch just collecting merge conflicts, so it's not perfect to say the least, and some of the code needs to be revisited in the near future while the context is still fresh in memory.

This is an umbrella issue for post-refactoring refactorings.

Issues:

  • Move analysis-related unit tests from dokka-base into the new analysis modules. Note: some tests rely on the implementation details, so some refactoring is needed as well. Assignee: @IgnatBeresnev
  • Add detailed descriptions for the new analysis modules. Update developer guides.
  • Add an internal switch between implementations (K1 and K2) of the Analysis API
  • Tidy up the Java Analysis module:
    • Remove excessive abstractions that were needed at the time of refactoring, but are not needed now.
    • Document the general flow and internals of the Java analysis, especially when it comes to how the @inheritdoc tag works.
    • Resolve numerous fresh TODO comments, marked as TODO [beresnev]
  • Remove the dependency on jsoup in analysis-markdown-jb (used for something insignificant)
  • Remove the dependency on analysis-markdown-jb in analysis-java-psi (used for something insignificant)
  • Resolve numerous fresh TODO comments in dokka-base and other modules. The TODOs are marked as TODO [beresnev]
@IgnatBeresnev IgnatBeresnev added tech-debt A technical issue that is not observable by the users, but improves maintainers quality of life language: Java Issue/PR related to the Java language feature/analysis/docs language: Kotlin Issue/PR related to the Kotlin language feature/analysis/docs labels Jul 4, 2023
@IgnatBeresnev IgnatBeresnev added the epic A large body of work that is broken down into smaller issues label Aug 11, 2023
@IgnatBeresnev IgnatBeresnev self-assigned this Aug 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
epic A large body of work that is broken down into smaller issues language: Java Issue/PR related to the Java language feature/analysis/docs language: Kotlin Issue/PR related to the Kotlin language feature/analysis/docs tech-debt A technical issue that is not observable by the users, but improves maintainers quality of life
Projects
None yet
Development

No branches or pull requests

1 participant