Hello,
Paul Ebermann skribs:
> I'm new to JSch and wonder if there is any documentation apart from the
> examples directory.
>
> As I didn't find any, I started to add javadoc comments to the public
> methods - is there any interest to put this back into the "official"
> distribution?
>
> Also, are there volunteers to read and check the documentation which I
> am simply creating from how I understand the sources and examples?
My current javadoc generated API documentation can be found here:
http://epaul.github.com/jsch-documentation/javadoc/
The classes JSch, Session and all the public Channel subclasses now have
documentation for
every public method (or at least for those which were there in 0.1.42 - I only
merged in
the changes for 0.1.44 today).
I will add more later while going through the code trying to understand it.
You can follow the source changes in the master branch of my github repository
jsch-documentation:
https://github.com/ePaul/jsch-documentation
Until now I didn't do any real changes, only adding comments (and modifying
some existing
ones, e.g. links or citations from the RFCs.)
Atsuhiko, should I send you my patches?
(Feel free to simply take them from github, though.)
Paŭlo
------------------------------------------------------------------------------
Xperia(TM) PLAY
It's a major breakthrough. An authentic gaming
smartphone on the nation's most reliable network.
And it wants your games.
http://p.sf.net/sfu/verizon-sfdev
_______________________________________________
JSch-users mailing list
JSch-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/jsch-users
