On 10/04/15 18:51, Arne Babenhauserheide wrote: > What slowed me down was the lack of practical, high level > documentation. Examples: > > - How to write a plugin which does anything remotely useful?¹ > - What callbacks are triggered when I request a key? And where do they run?² > - Ĥow do Toadlets work? (turns out that that isn’t that complex after all) > > ¹: See my try at writing a plugin tutorial, putting it off halfway > because it was getting unbearable: > https://d6.gnutella2.info/freenet/USK@xqbzQkEGFnFfZH3LG~ut8bjV51o~3nrIXMN3ld5Qjs0,SThdqkHICKxLZvKzMcfK4w04Y4ykcE1~lmQiskpsVqw,AQACAAE/freenet-plugin-bare/5/ > > ²: What does a PutHandler do, where is it fired and why is there a > JokerPutHandler? > https://github.com/freenet/fred/blob/c314c517e421b683f6676b109b95145151da22fc/src/freenet/client/async/BaseManifestPutter.java#L329 > > These issues aren’t fixed by JavaDoc. The latter might be fixed by good javadocs on BaseManifestPutter and its inner classes. The site insert code is pretty arcane. > They are fixed by a Hacking Guide: “For those who come after me.” > > At the same time there are quite a few things which only toad can do > efficiently, because only he knows the code well enough to anticipate > the side effects of the changes, or where they have to be wired in. > > Note that documenting the API is something completely different than > just throwing in JavaDoc. The FCPv2 documentation in the Wiki is an > example of documentation which works: Whenever I did something with > pyFreenet, that documentation helped enormously. > > Something like that for the Plugin API. Maybe focussed to answer the > question “How to write a plugin in such a way that it can easily be > made official?”
signature.asc
Description: OpenPGP digital signature
_______________________________________________ Devl mailing list Devl@freenetproject.org https://emu.freenetproject.org/cgi-bin/mailman/listinfo/devl
