[ 
https://issues.apache.org/jira/browse/METRON-1361?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16290944#comment-16290944
 ] 

Casey Stella commented on METRON-1361:
--------------------------------------

Sure..I'd be in.  I think a first step would be to automate the stellar 
documentation generation and we could add a new annotation for namespaces.  I 
know that Justin Leet has done some good work looking into documentation 
generation approaches via doclet.

> STELLAR Support Namespace Documentation
> ---------------------------------------
>
>                 Key: METRON-1361
>                 URL: https://issues.apache.org/jira/browse/METRON-1361
>             Project: Metron
>          Issue Type: New Feature
>            Reporter: Otto Fowler
>            Assignee: Otto Fowler
>
> Stellar namespaces are used to group sets of common functionality together 
> into logical sets.  When documenting individual functions, it can be 
> repetitive and awkward to introduce concepts common to the namespace.
> Stellar should allow some mechanism for documenting the namespace itself, 
> where the purpose of the namespace and the context for the functions are 
> defined



--
This message was sent by Atlassian JIRA
(v6.4.14#64029)

Reply via email to