RE: [MO-java-dev] Java Doc

[Vincent M. <vm...@oc...>]

+1 to that. 

But we also need an "architecture" document or a "user guide" document
that explains what an Expectation is (the probe notion), how it works,
that there is a core and what it provides, etc. This in addition better
naming conventions. I think the original paper is nice but too complex
to understand for a newcomer. We need something easier ...

-Vincent

> -----Original Message-----
> From: moc...@li...
> [mailto:moc...@li...] On Behalf Of
Nat
> Pryce
> Sent: 26 August 2002 22:06
> To: Mockobjects-Java-Dev
> Subject: Re: [MO-java-dev] Java Doc
> 
> 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
> 
> 
> 
> 
> -------------------------------------------------------
> This sf.net email is sponsored by: OSDN - Tired of that same old
> cell phone?  Get a new here for FREE!
> https://www.inphonic.com/r.asp?r=sourceforge1&refcode1=vs3390
> _______________________________________________
> Mockobjects-java-dev mailing list
> Moc...@li...
> https://lists.sourceforge.net/lists/listinfo/mockobjects-java-dev