Re: [DISCUSS] Stellar Documentation Autogeneration

2017-12-15 Thread Justin Leet
I created a ticket, https://issues.apache.org/jira/browse/METRON-1363 to track this. I also noticed that we might be able to swipe from Nifi. Looks like they generate a nice page for their stuff based on annotations and we may be able to adapt it to what we have. I haven't looked at their code at

Re: [DISCUSS] Stellar Documentation Autogeneration

2017-12-14 Thread Matt Foley
+1 from me too, Justin. Great idea. On 12/14/17, 12:44 PM, "zeo...@gmail.com" wrote: A huge +1 from me. This would be great On Thu, Dec 14, 2017 at 3:39 PM Michael Miklavcic < michael.miklav...@gmail.com> wrote: > +1 from me, great idea Justin. I

Re: [DISCUSS] Stellar Documentation Autogeneration

2017-12-14 Thread zeo...@gmail.com
A huge +1 from me. This would be great On Thu, Dec 14, 2017 at 3:39 PM Michael Miklavcic < michael.miklav...@gmail.com> wrote: > +1 from me, great idea Justin. I did a bit of digging around also and the > Doclet approach you're already using seems the way to go. I didn't come > across any

Re: [DISCUSS] Stellar Documentation Autogeneration

2017-12-14 Thread Michael Miklavcic
+1 from me, great idea Justin. I did a bit of digging around also and the Doclet approach you're already using seems the way to go. I didn't come across any libraries that would make this easier or better. Not sure if Swagger has anything along these lines? On Thu, Dec 14, 2017 at 1:00 PM, Otto

Re: [DISCUSS] Stellar Documentation Autogeneration

2017-12-14 Thread Otto Fowler
I think this is a great idea, and I looked at the POC and it isn’t as bad as you make it out to be;) What I would like to see is documentation for Stellar functions, by namespace generated. I would also like the capability to document at the namespace level. Often we have namespace level

Re: [DISCUSS] Stellar Documentation Autogeneration

2017-12-14 Thread Casey Stella
chiming in with a +1 on my end too. This would be fantastic. On Thu, Dec 14, 2017 at 2:51 PM, Nick Allen wrote: > +1 I think it is a great idea, Justin and the only way that we'll keep the > docs in-sync with the code. > > > > > > On Thu, Dec 14, 2017 at 2:32 PM Justin Leet

Re: [DISCUSS] Stellar Documentation Autogeneration

2017-12-14 Thread Nick Allen
+1 I think it is a great idea, Justin and the only way that we'll keep the docs in-sync with the code. On Thu, Dec 14, 2017 at 2:32 PM Justin Leet wrote: > I think it would be valuable to have the documentation around Stellar being > autogenerated. We have most of

[DISCUSS] Stellar Documentation Autogeneration

2017-12-14 Thread Justin Leet
I think it would be valuable to have the documentation around Stellar being autogenerated. We have most of the info we'd want in the @Stellar annotation, and ideally, we could just pull this info out and produce some docs similar to what we already manually maintain. This came up a bit in the