On 11/04/15 09:57, Arne Babenhauserheide wrote: > Am Samstag, 11. April 2015, 01:53:22 schrieb Matthew Toseland: >> The latter might be fixed by good javadocs on BaseManifestPutter and its >> inner classes. The site insert code is pretty arcane. > I think it would be easier to find in general documentation about > insert code, with simply a link to that in the javadoc. That’s then > also something we can show new people: “this is how our inserts work”. No, this is *site inserts*. As I said, that code is pretty arcane, and I didn't write it (Saces did). It needs to be explained largely at the class level IMHO, because any other kind of inserts works differently. > I’m not opposed to JavaDoc. Use it where it helps. But it’s not a goal > in itself, just one of many tools to achieve the goal of making it > easier to work with Freenet. Right. This particular example is only relevant to the handful of classes involved in site inserts. One way to deal with it would be detailed class-level explanations.
signature.asc
Description: OpenPGP digital signature
_______________________________________________ Devl mailing list Devl@freenetproject.org https://emu.freenetproject.org/cgi-bin/mailman/listinfo/devl
