Forum Discussion

ydc_19684's avatar
ydc_19684
Icon for Nimbostratus rankNimbostratus
Oct 03, 2007

javadocs?

Just starting out a development project using the iControl Java Wrapper with eclipse for an IDE. One thing that is a bit of a stumbling block is that there doesn't appear to be any javadocs for these classes included in the download. This results in eclipse not being able to offer assistance for method parameters and such and I'm left with looking at the Word doc for the Wrapper stuff and the online iControl API stuff for the rest.

 

 

Any way we can get javadocs added to the JavaWrapper (and the java assembly) downloads to help out the development process?
  • I don't believe we have JavaDocs for the wrappers or the assembly. I can speak for the assembly since I wrote that one. I'll let Don speak for the wrappers.

     

     

    As for the assembly, that contains 2500+ methods that are autogenerated from WSDL2Java. If I was to hand document this, it would take me a LONG time... If there is some way to auto-include javadoc documentation from the source WSDLs in the generated client proxies, I'd be glad to run javadoc on the sources and provide that documentation but as far as I know, the autogeneration of the javadoc comments in the code isn't in WSDL2Java. Let me know if I'm wrong on this.

     

     

    -Joe
  • Don_MacVittie_1's avatar
    Don_MacVittie_1
    Historic F5 Account
    Actually Joe, the comments are in the generated Java files - we may have to do a search and replace to get them into JavaDoc format instead of comment format - I'd have to look, don't recall which they're in.

     

     

    Dann - There are currently no JavaDocs for the Wrappers because they pull from several different places. I'll get them set up for just the wrapper classes, and that will be a start. My plate is kind of full at the moment though, so it may be a bit before I have it all set up.

     

     

    Don.