Oskar Sandberg wrote:
> > Fred is layered, sure. But there's little or no documentation on how
> > classes interact, what they are responsible for, and why they do what
> > they do. The architecture isn't documented.
>
> It's not completely javadoced, but a lot of it is.
The classes are documented. The architecture is not.
The javadocs show the class inheritance hierarchy nicely. What they
don't show is the object instance hierarchy - who owns what. I can't
speak for anyone else, but that's the first thing I want to know when
approaching unknown code.
> Yes, but we cannot possibly have a long documentation for every single
> block of code.
I'm not criticizing the in-code documentation. It's clear enough.
> Tell us, where are the javadocs not clear? Where are
> comments needed? Where is the role of a class not clear?
>
> There is so much whining, but so little constructive critisism.
I don't have specific questions because I'm not trying to understand
Fred. I'm just trying to give you an idea of the problems new
developers are likely to experience when approaching Fred and Freenet.
Guess that makes me a whiner.
The comments and javadocs are micro-level. They're bottom-up. They're
useful for people who already understand how things fit together.
There's very little top-down documentation. That's what the newbies
need. For Fred, a description of how things fit together. For Freenet,
an accurate protocol description.
--
mailto:[EMAIL PROTECTED] F289 2BDB 1DA0 F4C4 DC87 EC36 B2E3 4E75 C853 FD93
http://zem.squidly.org "..I'm invisible, I'm invisible, I'm invisible.."
_______________________________________________
Freenet-dev mailing list
[EMAIL PROTECTED]
http://lists.sourceforge.net/mailman/listinfo/freenet-dev
