Hi, I had a quick look into it. JavaDoc can simply be added to the thrift code and is copied into generated Java and Python source code files.
I modified storm.thrift and re-generated the code as described in DEVELOPER.md: cd storm-core/src sh genthrift.sh I pushed my changed to my git repo, in case you want to have a quick look: https://github.com/mjsax/storm I opened a JIRA, too: https://issues.apache.org/jira/browse/STORM-792 If you like it, I can open a pull request. Of course, it would be nice to add some more comments to all methods and interfaces. -Matthias On 04/20/2015 07:52 PM, Bobby Evans wrote: > I totally agree there is a lot in the documentation that would be good to do. > For the generated code I'm not totally sure how to make javadocs work. If > you want to file a JIRA for this we can look at it. > - Bobby > > > > On Saturday, April 18, 2015 9:49 AM, Matthias J. Sax > <[email protected]> wrote: > > > Thanks! > > It is a petty, that this information in not documented via JavaDoc... > That would make life much easier and would save time for everybody (=> > no need to ask and answer "stupid" questions on the mailing list) > > -Matthias > > On 04/17/2015 06:13 PM, Bobby Evans wrote: >> getTopology returns the compiled topology after nimbus has gotten its hands >> on it, so it has the ackers in it and the metrics consumers. getUserTopology >> returns the topology as the user submitted it. >> - Bobby >> >> >> >> On Friday, April 17, 2015 4:24 AM, Matthias J. Sax >> <[email protected]> wrote: >> >> >> Dear all, >> >> the class backtype.storm.generated.Nimbus defines a nested class >> Nimbus$Cluster that offers the following two methods (both defined in >> Nimbus#Iface): >> >>> public StormTopology getTopology(String id) throws NotAliveException, >>> org.apache.thrift.TException; >>> public StormTopology getUserTopology(String id) throws >>> NotAliveException, org.apache.thrift.TException; >> >> What is the difference between both? I don't understand what the >> difference between a "(regular?) topology" and a "user topology" should >> be... From my understanding, there is only one "type" of topologies. >> >> >> Thanks for you help! >> >> >> -Matthias >> >> >> >> > > > >
signature.asc
Description: OpenPGP digital signature
