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

Fix Javadoc Warnings #2

Open
neotheprogramist opened this issue Oct 30, 2023 · 0 comments
Open

Fix Javadoc Warnings #2

neotheprogramist opened this issue Oct 30, 2023 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@neotheprogramist
Copy link
Member

Description:

While executing the ./gradlew artifactoryPublish command in the VerkleTries_Besu project, multiple warnings are observed related to incomplete Javadoc.

Example warning:

VerkleTries_Besu/ipa-multipoint/src/main/java/org/hyperledger/besu/ethereum/trie/verkle/TrieKeyAdapter.java:45: warning: no comment
public Bytes32 storageKey(Bytes32 address, UInt256 storageKey) {

Objective:

Complete the Javadoc for the respective classes and methods to eliminate these warnings.

Note:

There's also an error regarding :artifactoryDeploy with a 401 status code. However, this will be addressed in a separate issue.

Acceptance Criteria:

  • No Javadoc warnings when running ./gradlew artifactoryPublish.
  • All added Javadocs should be relevant and provide clarity about the method or class it describes.
@neotheprogramist neotheprogramist added documentation Improvements or additions to documentation good first issue Good for newcomers labels Oct 30, 2023
@Uacias Uacias self-assigned this Oct 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants