Re: [MO-java-dev] Java Doc

[Nat P. <nat...@b1...>]

Just to stick my oar in... the mock objects library is really divided
into two parts, the core com.mockobjects package, which contains the
expectation classes and MockObject base class, and then the packages of
classes that mock actual APIs.  

The com.mockobjects package is so simple that I have not found a need
for documentation beyond the source and tests.  The other packages
implement predefined interfaces (already documented by Sun, for
example), and add setExpected... and setup... methods, the names of
which follow strict conventions and are derived from the method and
parameter names defined by the API.

The steepest part of the learning curve, in my experience, was learning
the naming conventions and how to apply the com.mockobject classes to
the mocking of my own interfaces.  The source to the mocked API packages
was useful guidance.

So, perhaps it would be better to write some tutorial documents,
explaining the naming conventions and how to use the classes in
com.mockobjects to create new mocks.  There already is a document on
naming conventions, but it is quite terse and the link is tucked away in
the corner of the mock objects home page.

Cheers,
	Nat. 

-- 
Dr. Nathaniel Pryce, Technical Director, B13media Ltd.
Studio 3a, 22-24 Highbury Grove, London N5 2EA, UK
http://www.b13media.com