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

Tech Debt: Update rename classes, methods and add some java doc. #179

Open
kshirsagarps opened this issue Nov 7, 2017 · 0 comments
Open

Comments

@kshirsagarps
Copy link
Collaborator

There are some classes we should rename to fit the 3.0 architecture and conventions.
Also, we should have sufficient java doc comments for the methods and follow common guidelines throughout the code.

Some of the findings that will help achieve above goal. It would also be good to read through the other parts of the code and have it updated.

InjectionTarget:

  • InjectionTarget can be renamed to BindingTarget.
  • No Java doc comment for the class, what is injection target? It's a DS but what data does it hold and why?

InjectionTargetUtil:

  • Can be renamed to BindingTargetUtil.
  • No java doc comment, java doc comments to build methods like getOrCreateTargetClass
  • For almost all the methods in various classes have the argument sequence - (
    TypeElement element, Map<TypeElement, InjectionTarget> targetClassMap), we should follow the same sequence

InjectExtraUtil:

  • Can be renamed to BindExtraUtil, maybe/not.
  • No java doc comment, java doc comments to build methods like
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

No branches or pull requests

1 participant