[英]How does nifi generate documentation?
Looking through Apache nifi's source, I see that they generate their documentation using @ symbols at the beginning of the code. 查看Apache nifi的源代码,我发现它们在代码的开头使用@符号生成了文档。 Here's an example for reference. 这是一个供参考的例子。 How is the documentation generated from these lines? 这些行如何生成文档? Is this possible using scala? 使用scala可以做到吗?
The @
symbols are syntax for Java Annotations , which Apache NiFi uses to mark up extension components for generating documentation. @
符号是Java注释的语法,Apache NiFi使用该语法标记扩展组件以生成文档。
NiFi documentation is generated by the nifi-documentation sub-project, part of the NiFi framework. NiFi文档是由NiFi框架的一部分nifi-documentation子项目生成的。 You can follow the details in the DocGenerator.generate method. 您可以遵循DocGenerator.generate方法中的详细信息。 There are some unit tests in the nifi-documentation project that will help you run through it. nifi文档项目中有一些单元测试可以帮助您完成它。
I'm not very familiar with Scala, but I believe you can read/write Java annotations. 我对Scala不太熟悉,但是我相信您可以读写Java注释。
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.