Ling Mao created CASSANDRA-18351:
------------------------------------
Summary: Add package-info files for each package
Key: CASSANDRA-18351
URL: https://issues.apache.org/jira/browse/CASSANDRA-18351
Project: Cassandra
Issue Type: Improvement
Components: Documentation/Javadoc
Reporter: Ling Mao
- To make the whole codebase more readable(especially for C* beginner), add
package-info files for each package to describe what each package did may be a
good choice.
- Look at an example from Netty:
https://github.com/netty/netty/blob/4.1/codec-redis/src/main/java/io/netty/handler/codec/redis/package-info.java
https://github.com/netty/netty/blob/4.1/handler-proxy/src/main/java/io/netty/handler/proxy/package-info.java
https://github.com/netty/netty/blob/4.1/buffer/src/main/java/io/netty/buffer/package-info.java
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
