How does nifi generate documentation?

Question

Looking through Apache nifi's source, I see that they generate their documentation using @ symbols at the beginning of the code. Here's an example for reference. How is the documentation generated from these lines? Is this possible using scala?

Answer 1

The @ symbols are syntax for Java Annotations , which Apache NiFi uses to mark up extension components for generating documentation.

NiFi documentation is generated by the nifi-documentation sub-project, part of the NiFi framework. You can follow the details in the DocGenerator.generate method. There are some unit tests in the nifi-documentation project that will help you run through it.

I'm not very familiar with Scala, but I believe you can read/write Java annotations.