Hi, Ah... It is really a big issue... using "/*" rather than "/**" for Apache Rat is correct. But it will change all files..
Any suggestions about what is the time to do that? Best, ----------------------------------- Xiangdong Huang School of Software, Tsinghua University 黄向东 清华大学 软件学院 Boris Zhu <[email protected]> 于2019年9月26日周四 上午11:39写道： > Hi, > > Yes, I will do it as much as I can. I see many other Apache projects having > API docs like spark[1] and flink[2]. API docs are generated from java > comments in source code. For example, > > /** > * constructor of CHUNK_GROUP_FOOTER. > * > * @param deviceID device ID > * @param dataSize data size > * @param numberOfChunks number of chunks > */ > > So the real thing to do is to perfect Java-style comments in the source > code. When I generate some JavaDoc, facing some problems. For instance, the > Apache license shouldn't be in Java-style comments, because JavaDoc tools > identified the Java-style comment and didn't skip the Apache license which > it should skip. I think a license should be in the block comment, and I > create a pr[3] to fix that. > > best, > Boris > > [1] https://spark.apache.org/docs/latest/api/java/index.html > [2] https://ci.apache.org/projects/flink/flink-docs-release-1.9/api/java/ > [3] https://github.com/apache/incubator-iotdb/pull/420 > > On Thu, Sep 26, 2019 at 10:36 AM Xiangdong Huang <[email protected]> > wrote: > > > Hi Boris, > > > > Are you interested in supplying the javadoc as possible as you can? > > I think some of committers can support help if you have questions when > > reading source codes.. > > > > Best, > > ----------------------------------- > > Xiangdong Huang > > School of Software, Tsinghua University > > > > 黄向东 > > 清华大学 软件学院 > > > > > > Boris Zhu <[email protected]> 于2019年9月25日周三 下午3:39写道： > > > > > Hi, > > > > > > The official site needs a JavaDoc API page to help users to use IoTDB. > I > > > deploy a simple JavaDoc API page (only for TsFile module)in my GitHub > > > pages[1]. > > > > > > But there are still many problems when I use the JavaDoc tool to > generate > > > JavaDoc and many Java-style comments need to be perfected. > > > > > > When you use an IntelliJ idea, you can use the tool in Tools-Generate > > > JavaDoc... > > > > > > Also, open an issue[2] > > > > > > Best Regards, > > > Boris > > > > > > [1] https://genius-pig.github.io/ > > > [2] https://issues.apache.org/jira/projects/IOTDB/issues/IOTDB-236 > > > > > >
