To: dougo@ccs.neu.edu, lieber@ccs.neu.edu
Subject: Re: DJ documentation
Cc: johan@ccs.neu.edu, lorenz@ccs.neu.edu, wupengcheng@yahoo.com

Hi Doug:

>From dougo@ccs.neu.edu  Thu Sep 14 19:27:48 2000
>Date: Thu, 14 Sep 2000 19:26:35 -0400 (EDT)
>To: Karl Lieberherr <lieber@ccs.neu.edu>
>Cc: johan@ccs.neu.edu, lorenz@ccs.neu.edu, wupengcheng@yahoo.com
>Subject: Re: DJ documentation
>
>Karl Lieberherr writes:
> > When I look at the library, I only get:
> > 
> > ClassGraph(boolean f, boolean m) 
> > 	   Make a class graph from all classes in the default package.
> > 
> > Why do I only get a part of the documentation?
>
>Javadoc puts summaries of each function at the top, alphabetically
>ordered (with constructors intheir own section) and with only one
>sentence in each description; the full documentation is below, in the
>same order as it appears in the .java file.  I haven't explored the
>javadoc options to see whether this can be customized.  Anyway, click
>on the constructor name to go to the full version below.

Thank you for the explanation.

>
> > You allow to add many packages. Do we get one big class graph or one
> > class graph per package?
>
>One big graph.  Each class name is fully qualified.

Good.

>
> > The fetch exception documentation: Is the FetchException thrown when
> > there is more than one path?
>
>Yes.  (This is mentioned in the documentation for
>ObjectGraphSlice.fetch(), but I need to copy this to the other fetch
>methods and probably to the FetchException class doc.)

You are right.

>
> > Is the IncompatibleClassGraphsException thrown by any method that
> > has a class graph g and a strategy s as argument and s and g are not compatible?
>
>Nope-- that situation throws a TraversalGraphException.
>IncompatibleClassGraphsException is thrown when you try to make an
>ObjectGraphSlice from an ObjectGraph and TraversalGraph that aren't
>relative to the same ClassGraph.  (Suggestions for a better name for
>this exception would be welcomed.)

Maybe good names would be:

EmptyTraversalGraphException or ClassGraphStrategyGraphException 
for TraversalGraphException 
and
ObjectGraphTraversalMismatchGraphException for IncompatibleClassGraphsException

>
> > Please can you update those parts of the documentation.
>
>I plan to make a more thorough pass through the docs after I finish
>writing the code.
>
>--Doug
>

-- Karl