Re: FlowSet documentation patch

[Chris Pickett <chris.pickett@mail.mcgill.ca>]

Hi,

Is there a problem with this patch?  I know it's terribly simple, but 
that "join" was there in the docs (and still is) was enough to make me 
check that the methods actually did what I expected, which was "meet". 
The rest is just capitalization, I figured I may as well fix it.

Cheers,
Chris

Chris Pickett wrote:
> Hi,
>
> Here is a simple documentation-only patch for FlowSet.java.
>
> Cheers,
> Chris
>
>
> ------------------------------------------------------------------------
>
> Index: src/soot/toolkits/scalar/FlowSet.java
> ===================================================================
> --- src/soot/toolkits/scalar/FlowSet.java	(revision 1507)
> +++ src/soot/toolkits/scalar/FlowSet.java	(working copy)
> @@ -47,7 +47,7 @@
>    public Object clone();
>  
>    /** 
> -   * returns an empty set, most often more efficient than:
> +   * Returns an empty set, most often more efficient than:
>     * <code>((FlowSet)clone()).clear()</code>
>     */
>    public Object emptySet();
> @@ -88,13 +88,13 @@
>    public void intersection(FlowSet other, FlowSet dest);
>  
>    /** 
> -   * Returns the set difference (this join ~other) of this FlowSet and
> +   * Returns the set difference (this meet ~other) of this FlowSet and
>     * <code>other</code>, putting result into <code>this</code>.
>     */
>    public void difference(FlowSet other);
>  
>    /**
> -   * Returns the set difference (this join ~other) of this FlowSet and 
> +   * Returns the set difference (this meet ~other) of this FlowSet and 
>     * <code>other</code>, putting result into <code>dest</code>.
>     * <code>dest</code>, <code>other</code> and <code>this</code> could be the
>     * same object.
> @@ -119,7 +119,7 @@
>    public void add(Object obj);
>  
>    /**
> -   * puts <code>this</code> union <code>obj</code> into <code>dest</code>.
> +   * Puts <code>this</code> union <code>obj</code> into <code>dest</code>.
>     */
>    public void add(Object obj, FlowSet dest);
>  
> @@ -139,7 +139,7 @@
>    public boolean contains(Object obj);
>  
>    /**
> -   * returns an iterator over the elements of the flowSet. Note that the
> +   * Returns an iterator over the elements of the flowSet. Note that the
>     * iterator might be backed, and hence be faster in the creation, than doing
>     * <code>toList().iterator()</code>.
>     */