Repository: incubator-blur Updated Branches: refs/heads/master 507a12eae -> ac7aaacd2
intermediate docs Project: http://git-wip-us.apache.org/repos/asf/incubator-blur/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-blur/commit/ac7aaacd Tree: http://git-wip-us.apache.org/repos/asf/incubator-blur/tree/ac7aaacd Diff: http://git-wip-us.apache.org/repos/asf/incubator-blur/diff/ac7aaacd Branch: refs/heads/master Commit: ac7aaacd26fb0958a5432df98d334a26f20eff2d Parents: 507a12e Author: twilliams <[email protected]> Authored: Wed Nov 12 22:34:54 2014 -0500 Committer: twilliams <[email protected]> Committed: Wed Nov 12 22:34:54 2014 -0500 ---------------------------------------------------------------------- docs/platform.html | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/ac7aaacd/docs/platform.html ---------------------------------------------------------------------- diff --git a/docs/platform.html b/docs/platform.html index 1062fcb..106f958 100644 --- a/docs/platform.html +++ b/docs/platform.html @@ -252,8 +252,16 @@ private short size = 10; <h2 id="docs">Documentation</h2> </div> <p> - <code>@TODO</code> + Commands should be self-documenting starting with a good name. But good naming + is not sufficient, so Blur offers a <code>@Description</code> annotation to provide + a nice way to better express what your command does. It's simply used like so: </p> + <pre> +@Description("Returns the number of documents containing the term in the given field.") +public class DocFreqCommand extends TableReadCommand<Long> { + ... +} + </pre> </section> <section>
