caver-java icon indicating copy to clipboard operation
caver-java copied to clipboard

Expose javadoc comments of private fields to the getter and setter method

Open majecty opened this issue 3 years ago • 1 comments

There are JavaDoc comments on the private fields in the TransactionData type.

https://github.com/klaytn/caver-java/blob/dev/core/src/main/java/com/klaytn/caver/methods/response/Transaction.java#L37

But the official JavaDoc site of caver-java does not show the information: https://javadoc.io/doc/com.klaytn.caver/core/latest/com/klaytn/caver/methods/response/Transaction.TransactionData.html

Also, IDEs like IntelliJ show the document of getter or setter when using the functions in code. However, it does not show the doc in the private fields.

The comments in the private fields will help programmers significantly. If we expose the docs more programmer-friendly, many programmers will be happier.

majecty avatar Mar 11 '21 01:03 majecty

Thanks for your opinion. I will consider it.

sirano11 avatar Apr 08 '21 04:04 sirano11