Re: [JSch-users] is there any documentation?

[Paul E. <Pau...@gm...>]

Atsuhiko Yamanaka schrieb:
> Hi,
> 
>    +-From: Paul Ebermann <Pau...@gm...> --
>    |_Date: Tue, 12 Apr 2011 23:56:53 +0200 __
>    |I think I have now documented everything to a degree the library is usable
>    |by reading the javadocs, without digging into the code.
>    |   http://epaul.github.com/jsch-documentation/
> 
> I have run WIKI at 
>   http://sourceforge.net/apps/mediawiki/jsch/index.php?title=Main_Page
> Originally, it had run at http://wiki.jsch.org/ as an effort to get contributions,
> but been knocked down by spams.
> Documentations for HOWTO will be also useful.  If possible, please add
> contributions there.

Ah, good to know. I will look at this (and maybe add more "overview" documentation from
the examples there).


What I did was adding javadoc comments to the source code, so now it is possible to read
the documentation and know for each method/class/interface what it does (or at least, what
I think it does/should do).
This should be added to the main distribution (maybe after someone else have read it and
either corrected errors or approved it).


Having examples and HOWTOs is independent of this.

Paul

PS: Seems I can't edit anything on the wiki - could you add the user ePaul
(https://sourceforge.net/apps/mediawiki/jsch/index.php?title=User:Epaul) to the group
"Editors"?