Re: [java-gnome-hackers] ProgressBar Orientation patch (Need revision)

[Andrew C. <an...@op...>]

In the main, your patch is fine. Some QA-ish points:

On Sun, 2009-01-11 at 20:37 +0100, Miloud Bel wrote:
> - * Copyright (c) 2007-2008 Operational Dynamics Consulting Pty Ltd,
> and Others
> + * Copyright (c) 2009 Operational Dynamics Consulting Pty Ltd, and
> Others

The correct change is to make it "2007-2009".

> +    /**
> +     * Set the orientation of the progress bar
> +     * Four possible values:
> +     * 
> +     * LEFT_TO_RIGHT
> +     * RIGHT_TO_LEFT
> +     * TOP_TO_BOTTOM
> +     * BOTTOM_TO_TOP

If you run javadoc over this (ie, do `make doc`) you will discover that
whitespace is not preserved (it is, to all intents, HTML) and so you'll
need to make that an <ul> list or use <br> if you want to have four
items.

I'm not really sure you need to list them, but whatever.
http://java-gnome.sourceforge.net/4.0/doc/api/org/gnome/pango/Style.html
is an example of where we were verbose about it.

You really ought to preview in a web browser. Like I said,

$ make doc

> +     * @param orientation
> +     *            a ProgressBarOrientation value

You don't need that.

> +    /**
> +     * Get the current progress bar orientation

if you're going to talk about the proper name of a class, then use the
class name:

        * Get orientation currently in effect in this ProgressBar.

or whatever. Perhaps Kenneth will volunteer to help you with the prose.

++

You also really need to run the code formatter before committing. Serkan
can help you with that, but if you're not in Eclipse:

$ make format

and if you are, Source -> Format.

AfC
Sydney

-- 
Andrew Frederick Cowie

Operational Dynamics is an operations and engineering consultancy
focusing on IT strategy, organizational architecture, systems
review, and effective procedures for change management: enabling
successful deployment of mission critical information technology in
enterprises, worldwide.

http://www.operationaldynamics.com/

Sydney   New York   Toronto   London