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

Refactor API design #294

Open
AnakinRaW opened this issue Sep 16, 2020 · 0 comments
Open

Refactor API design #294

AnakinRaW opened this issue Sep 16, 2020 · 0 comments
Assignees

Comments

@AnakinRaW
Copy link
Collaborator

AnakinRaW commented Sep 16, 2020

Crypto-Analysis, as far as I see this, currently is in an "ugly" state.
The following list identifies some items I think we should change before version 2.8.0 gets stable:

  • The package CryptoAnalysis mixes API and CLI wrappers. I think we should have two individual packages where one only contains the API and the other CIL stuff including a main method.
    • This also applies for the Crypto-Analysis-Android package.
  • The API looks somewhat miss-structured. For example we have three different classes capable of creating CrySLRules. They are all in different packages.
    • This also includes removing classes/methods that are deprecated.
  • The API lacks of documentation. For all public/protected members we should have Javadoc.
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

2 participants