[Potlatch-dev] API documentation

[Andy Allan]

On Sat, Nov 27, 2010 at 6:29 AM, Steve Bennett <stevagewp at gmail.com> wrote:
> On Thu, Nov 25, 2010 at 10:21 PM, Andy Allan <gravitystorm at gmail.com> wrote:
>> or you can read the ones that Dave automatically generates at
>>
>> http://random.dev.openstreetmap.org/potlatch2/docs/
>
> Yay. I find even automatically generated *-docs beat the hell out of
> skimming source.
>
>> If there's anyone who wants to see any particular part of the code
>> documented, let me know and I'll sort it out.
>
> Since you asked, my only request would be for a breadth-first coverage
> - describing the purpose of every top level class. In particular,
> conveying to the reader why they might (or not) be interested in
> delving further.

Well, I've just done every top-level package (r24478), but I'll need
to work through the classes as I go - it's a ton of work!

Cheers,
Andy