8133807: java.desktop docs: replace some invalid "@returns" tags

Reviewed-by: alexsch
This commit is contained in:
Alexander Stepanov 2015-08-27 18:09:09 +03:00
parent 7436faa3d1
commit 2f6a5f4af7
17 changed files with 33 additions and 33 deletions

View file

@ -224,7 +224,7 @@ MimeTypeParameterList(rawdata.substring(semIndex));
* Set the value to be associated with the given name, replacing * Set the value to be associated with the given name, replacing
* any previous association. * any previous association.
* *
* @throw IllegalArgumentException if parameter or value is illegal * @throws IllegalArgumentException if parameter or value is illegal
*/ */
public void setParameter(String name, String value) { public void setParameter(String name, String value) {
parameters.set(name, value); parameters.set(name, value);
@ -233,7 +233,7 @@ MimeTypeParameterList(rawdata.substring(semIndex));
/** /**
* Remove any value associated with the given name. * Remove any value associated with the given name.
* *
* @throw IllegalArgumentException if parameter may not be deleted * @throws IllegalArgumentException if parameter may not be deleted
*/ */
public void removeParameter(String name) { public void removeParameter(String name) {
parameters.remove(name); parameters.remove(name);

View file

@ -517,7 +517,7 @@ abstract class MultipleGradientPaintContext implements PaintContext {
* *
* @param position the unmanipulated position, which will be mapped * @param position the unmanipulated position, which will be mapped
* into the range 0 to 1 * into the range 0 to 1
* @returns integer color to display * @return integer color to display
*/ */
protected final int indexIntoGradientsArrays(float position) { protected final int indexIntoGradientsArrays(float position) {
// first, manipulate position value depending on the cycle method // first, manipulate position value depending on the cycle method

View file

@ -448,7 +448,7 @@ public abstract class Toolkit {
* *
* @param s the error message * @param s the error message
* @param e the original exception * @param e the original exception
* @throw the new AWTError including the cause (the original exception) * @throws the new AWTError including the cause (the original exception)
*/ */
private static void newAWTError(Throwable e, String s) { private static void newAWTError(Throwable e, String s) {
AWTError newAWTError = new AWTError(s); AWTError newAWTError = new AWTError(s);

View file

@ -90,7 +90,7 @@ public class LayerUI<V extends Component>
* and set the layer event mask to {@code 0} * and set the layer event mask to {@code 0}
* in {@link #uninstallUI(javax.swing.JComponent)} after that. * in {@link #uninstallUI(javax.swing.JComponent)} after that.
* By default this method calls the appropriate * By default this method calls the appropriate
* {@code process&lt;event&nbsp;type&gt;Event} * {@code process<event}&nbsp;{@code type>Event}
* method for the given class of event. * method for the given class of event.
* <p> * <p>
* <b>Note:</b> Events are processed only for displayable {@code JLayer}s. * <b>Note:</b> Events are processed only for displayable {@code JLayer}s.

View file

@ -298,8 +298,8 @@ public void close()
* Handles a parameterless RTF keyword. This is called by the superclass * Handles a parameterless RTF keyword. This is called by the superclass
* (RTFParser) when a keyword is found in the input stream. * (RTFParser) when a keyword is found in the input stream.
* *
* @returns <code>true</code> if the keyword is recognized and handled; * @return true if the keyword is recognized and handled;
* <code>false</code> otherwise * false otherwise
* @see RTFParser#handleKeyword * @see RTFParser#handleKeyword
*/ */
public boolean handleKeyword(String keyword) public boolean handleKeyword(String keyword)
@ -444,8 +444,8 @@ public boolean handleKeyword(String keyword)
* This is called by the superclass * This is called by the superclass
* (RTFParser) when a keyword is found in the input stream. * (RTFParser) when a keyword is found in the input stream.
* *
* @returns <code>true</code> if the keyword is recognized and handled; * @return true if the keyword is recognized and handled;
* <code>false</code> otherwise * false otherwise
* @see RTFParser#handleKeyword * @see RTFParser#handleKeyword
*/ */
public boolean handleKeyword(String keyword, int parameter) public boolean handleKeyword(String keyword, int parameter)
@ -553,7 +553,7 @@ defineCharacterSet(String name, char[] table)
* array of characters, mapping unsigned byte values to their Unicode * array of characters, mapping unsigned byte values to their Unicode
* equivalents. The character set is loaded if necessary. * equivalents. The character set is loaded if necessary.
* *
* @returns the character set * @return the character set
*/ */
public static Object public static Object
getCharacterSet(final String name) getCharacterSet(final String name)
@ -577,7 +577,7 @@ getCharacterSet(final String name)
* must contain 256 decimal integers, separated by whitespace, with * must contain 256 decimal integers, separated by whitespace, with
* no punctuation. B- and C- style comments are allowed. * no punctuation. B- and C- style comments are allowed.
* *
* @returns the newly read character set * @return the newly read character set
*/ */
static char[] readCharset(InputStream strm) static char[] readCharset(InputStream strm)
throws IOException throws IOException
@ -1349,7 +1349,7 @@ abstract class AttributeTrackingDestination implements Destination
* Calculates the current text (character) attributes in a form suitable * Calculates the current text (character) attributes in a form suitable
* for SwingText from the current parser state. * for SwingText from the current parser state.
* *
* @returns a new MutableAttributeSet containing the text attributes. * @return a new MutableAttributeSet containing the text attributes.
*/ */
MutableAttributeSet currentTextAttributes() MutableAttributeSet currentTextAttributes()
{ {
@ -1410,7 +1410,7 @@ abstract class AttributeTrackingDestination implements Destination
* Calculates the current paragraph attributes (with keys * Calculates the current paragraph attributes (with keys
* as given in StyleConstants) from the current parser state. * as given in StyleConstants) from the current parser state.
* *
* @returns a newly created MutableAttributeSet. * @return a newly created MutableAttributeSet.
* @see StyleConstants * @see StyleConstants
*/ */
MutableAttributeSet currentParagraphAttributes() MutableAttributeSet currentParagraphAttributes()
@ -1449,7 +1449,7 @@ abstract class AttributeTrackingDestination implements Destination
* Calculates the current section attributes * Calculates the current section attributes
* from the current parser state. * from the current parser state.
* *
* @returns a newly created MutableAttributeSet. * @return a newly created MutableAttributeSet.
*/ */
public AttributeSet currentSectionAttributes() public AttributeSet currentSectionAttributes()
{ {

View file

@ -50,7 +50,7 @@ class DefaultShellFolder extends ShellFolder {
* this default implementation can always be represented with a * this default implementation can always be represented with a
* <code>java.io.File</code> object instead. * <code>java.io.File</code> object instead.
* *
* @returns a <code>java.io.File</code> replacement object. * @return a java.io.File replacement object.
*/ */
protected Object writeReplace() throws java.io.ObjectStreamException { protected Object writeReplace() throws java.io.ObjectStreamException {
return new File(getPath()); return new File(getPath());

View file

@ -67,7 +67,7 @@ public abstract class ShellFolder extends File {
* <code>java.io.File</code> instead. If not, then the object is most likely * <code>java.io.File</code> instead. If not, then the object is most likely
* depending on some internal (native) state and cannot be serialized. * depending on some internal (native) state and cannot be serialized.
* *
* @returns a <code>java.io.File</code> replacement object, or <code>null</code> * @return a java.io.File replacement object, or null
* if no suitable replacement can be found. * if no suitable replacement can be found.
*/ */
protected abstract Object writeReplace() throws java.io.ObjectStreamException; protected abstract Object writeReplace() throws java.io.ObjectStreamException;

View file

@ -419,7 +419,7 @@ public class PSPrinterJob extends RasterPrinterJob {
/** /**
* Presents the user a dialog for changing properties of the * Presents the user a dialog for changing properties of the
* print job interactively. * print job interactively.
* @returns false if the user cancels the dialog and * @return false if the user cancels the dialog and
* true otherwise. * true otherwise.
* @exception HeadlessException if GraphicsEnvironment.isHeadless() * @exception HeadlessException if GraphicsEnvironment.isHeadless()
* returns true. * returns true.

View file

@ -964,7 +964,7 @@ public abstract class RasterPrinterJob extends PrinterJob {
/** /**
* Presents the user a dialog for changing properties of the * Presents the user a dialog for changing properties of the
* print job interactively. * print job interactively.
* @returns false if the user cancels the dialog and * @return false if the user cancels the dialog and
* true otherwise. * true otherwise.
* @exception HeadlessException if GraphicsEnvironment.isHeadless() * @exception HeadlessException if GraphicsEnvironment.isHeadless()
* returns true. * returns true.

View file

@ -96,7 +96,7 @@ class MotifDnDDragSourceProtocol extends XDragSourceProtocol
/** /**
* Processes the specified client message event. * Processes the specified client message event.
* *
* @returns true if the event was successfully processed. * @return true if the event was successfully processed.
*/ */
public boolean processClientMessage(XClientMessageEvent xclient) { public boolean processClientMessage(XClientMessageEvent xclient) {
if (xclient.get_message_type() != if (xclient.get_message_type() !=

View file

@ -68,7 +68,7 @@ class XDnDDragSourceProtocol extends XDragSourceProtocol {
/** /**
* Performs protocol-specific drag initialization. * Performs protocol-specific drag initialization.
* *
* @returns true if the initialized successfully. * @return true if the initialized successfully.
*/ */
protected void initializeDragImpl(int actions, Transferable contents, protected void initializeDragImpl(int actions, Transferable contents,
Map<Long, DataFlavor> formatMap, long[] formats) Map<Long, DataFlavor> formatMap, long[] formats)

View file

@ -379,7 +379,7 @@ public final class XDragSourceContextPeer
/** /**
* Updates the source action according to the specified state. * Updates the source action according to the specified state.
* *
* @returns true if the source * @return true if the source
*/ */
private boolean updateSourceAction(int state) { private boolean updateSourceAction(int state) {
int action = SunDragSourceContextPeer.convertModifiersToDropAction(XWindow.getModifiers(state, 0, 0), int action = SunDragSourceContextPeer.convertModifiersToDropAction(XWindow.getModifiers(state, 0, 0),
@ -570,7 +570,7 @@ public final class XDragSourceContextPeer
/** /**
* The caller must own awtLock. * The caller must own awtLock.
* *
* @returns true if the even was processed and shouldn't be passed along. * @return true if the event was processed and shouldn't be passed along.
*/ */
private boolean doProcessEvent(XEvent ev) { private boolean doProcessEvent(XEvent ev) {
assert XToolkit.isAWTLockHeldByCurrentThread(); assert XToolkit.isAWTLockHeldByCurrentThread();

View file

@ -140,7 +140,7 @@ abstract class XDragSourceProtocol {
/** /**
* Processes the specified client message event. * Processes the specified client message event.
* *
* @returns true if the event was successfully processed. * @return true if the event was successfully processed.
*/ */
public abstract boolean processClientMessage(XClientMessageEvent xclient) public abstract boolean processClientMessage(XClientMessageEvent xclient)
throws XException; throws XException;

View file

@ -293,7 +293,7 @@ public abstract class X11InputMethod extends InputMethodAdapter {
/** /**
* Query and then return the current composition state. * Query and then return the current composition state.
* @returns the composition state if isCompositionEnabled call * @return the composition state if isCompositionEnabled call
* is successful. Otherwise, it returns false. * is successful. Otherwise, it returns false.
*/ */
private boolean getCompositionState() { private boolean getCompositionState() {

View file

@ -97,14 +97,14 @@ public final class Win32GraphicsEnvironment extends SunGraphicsEnvironment {
* Returns the number of pixels per logical inch along the screen width. * Returns the number of pixels per logical inch along the screen width.
* In a system with multiple display monitors, this value is the same for * In a system with multiple display monitors, this value is the same for
* all monitors. * all monitors.
* @returns number of pixels per logical inch in X direction * @return number of pixels per logical inch in X direction
*/ */
public native int getXResolution(); public native int getXResolution();
/** /**
* Returns the number of pixels per logical inch along the screen height. * Returns the number of pixels per logical inch along the screen height.
* In a system with multiple display monitors, this value is the same for * In a system with multiple display monitors, this value is the same for
* all monitors. * all monitors.
* @returns number of pixels per logical inch in Y direction * @return number of pixels per logical inch in Y direction
*/ */
public native int getYResolution(); public native int getYResolution();

View file

@ -556,7 +556,7 @@ public final class WPrinterJob extends RasterPrinterJob
/** /**
* Presents the user a dialog for changing properties of the * Presents the user a dialog for changing properties of the
* print job interactively. * print job interactively.
* @returns false if the user cancels the dialog and * @return false if the user cancels the dialog and
* true otherwise. * true otherwise.
* @exception HeadlessException if GraphicsEnvironment.isHeadless() * @exception HeadlessException if GraphicsEnvironment.isHeadless()
* returns true. * returns true.

View file

@ -201,7 +201,7 @@ public class D3DScreenUpdateManager extends ScreenUpdateManager
* - it's one of the classes likely to have custom rendering worth * - it's one of the classes likely to have custom rendering worth
* accelerating * accelerating
* *
* @returns true if we can use a d3d surface for this peer's onscreen * @return true if we can use a d3d surface for this peer's onscreen
* rendering * rendering
*/ */
public static boolean canUseD3DOnScreen(final WComponentPeer peer, public static boolean canUseD3DOnScreen(final WComponentPeer peer,