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

Justin Leet commented on METRON-1361:
-------------------------------------

To add some context to that, on the side I did a super, super rough attempt at 
parsing out the Stellar annotation as part of a doclet in order to 
automatically write it out to a file. There's about 80 things that would need 
to happen (including proving some of them can happen) to make that even vaguely 
usable, but having the namespace built right into the annotation would be very 
helpful towards building something that can actually be organized without a lot 
of extra work.

> 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