GitHub user wushujames opened a pull request:
https://github.com/apache/kafka/pull/1202
[WIP] KAFKA-3480: Autogenerate metrics documentation
This is a proof of concept for autogenerating documentation for metrics, to
see whether this approach is feasible.
I applied it to the metrics in the TestMetrics.java file. I will attach the
generated file to the JIRA, for reference.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/wushujames/kafka metrics_docs
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/kafka/pull/1202.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #1202
----
commit af70dc2f62897745d86169d900df4b6fe39c9d6b
Author: James Cheng <jylch...@yahoo.com>
Date: 2016-04-08T01:35:10Z
Proof of concept for auto generating metrics documentation.
commit d01b49894f82c90de41fa5992b50c71b8b1ed717
Author: James Cheng <jylch...@yahoo.com>
Date: 2016-04-08T01:36:52Z
Merge remote-tracking branch 'origin/trunk' into metrics_docs
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---
