Menu
▾
▴
[Jnode-svn-commits] SF.net SVN: jnode:[5154] trunk
|
From: <cr...@us...> - 2009-03-25 14:02:32
|
Revision: 5154
http://jnode.svn.sourceforge.net/jnode/?rev=5154&view=rev
Author: crawley
Date: 2009-03-25 14:02:21 +0000 (Wed, 25 Mar 2009)
Log Message:
-----------
Javadoc fixes
Modified Paths:
--------------
trunk/core/src/classpath/gnu/gnu/java/awt/ClasspathToolkit.java
trunk/core/src/classpath/gnu/gnu/java/awt/peer/ClasspathFontPeer.java
trunk/fs/src/driver/org/jnode/driver/block/scsi/cdrom/SCSICDROMDriver.java
trunk/gui/src/awt/org/jnode/awt/JNodeAwtContext.java
trunk/gui/src/awt/org/jnode/awt/JNodeGenericPeer.java
trunk/gui/src/awt/org/jnode/awt/font/FontProvider.java
trunk/gui/src/awt/org/jnode/awt/font/JNodeFontPeer.java
trunk/gui/src/awt/org/jnode/awt/font/bdf/BDFFontProvider.java
Modified: trunk/core/src/classpath/gnu/gnu/java/awt/ClasspathToolkit.java
===================================================================
--- trunk/core/src/classpath/gnu/gnu/java/awt/ClasspathToolkit.java 2009-03-25 13:09:26 UTC (rev 5153)
+++ trunk/core/src/classpath/gnu/gnu/java/awt/ClasspathToolkit.java 2009-03-25 14:02:21 UTC (rev 5154)
@@ -90,7 +90,7 @@
*
* <p>This method is specific to GNU Classpath. It gets called by
* the Classpath implementation of {@link
- * GraphicsEnvironment.getLocalGraphcisEnvironment()}.
+ * GraphicsEnvironment#getLocalGraphicsEnvironment()}.
*/
public abstract GraphicsEnvironment getLocalGraphicsEnvironment();
Modified: trunk/core/src/classpath/gnu/gnu/java/awt/peer/ClasspathFontPeer.java
===================================================================
--- trunk/core/src/classpath/gnu/gnu/java/awt/peer/ClasspathFontPeer.java 2009-03-25 13:09:26 UTC (rev 5153)
+++ trunk/core/src/classpath/gnu/gnu/java/awt/peer/ClasspathFontPeer.java 2009-03-25 14:02:21 UTC (rev 5154)
@@ -619,9 +619,9 @@
public abstract boolean canDisplay (Font font, char c);
/**
- * Implementation of {@link Font#canDisplay(String)},
- * {@link Font#canDisplay(char [], int, int)}, and
- * {@link Font#canDisplay(CharacterIterator, int, int)}.
+ * Implementation of {@link Font#canDisplayUpTo(String)},
+ * {@link Font#canDisplayUpTo(char [], int, int)}, and
+ * {@link Font#canDisplayUpTo(CharacterIterator, int, int)}.
*
* @param font the font this peer is being called from. This may be
* useful if you are sharing peers between Font objects. Otherwise it may
@@ -757,8 +757,7 @@
/**
- * Implementation of {@link Font#createGlyphVector(FontRenderContext,
- * int[])}.
+ * Implementation of {@link Font#createGlyphVector(FontRenderContext, int[])}.
*
* @param font the font object that the created GlyphVector will return
* when it gets asked for its font. This argument is needed because the
@@ -788,8 +787,6 @@
/**
- * Implementation of {@link Font#getFontMetrics()}
- *
* @param font the font this peer is being called from. This may be
* useful if you are sharing peers between Font objects. Otherwise it may
* be ignored.
Modified: trunk/fs/src/driver/org/jnode/driver/block/scsi/cdrom/SCSICDROMDriver.java
===================================================================
--- trunk/fs/src/driver/org/jnode/driver/block/scsi/cdrom/SCSICDROMDriver.java 2009-03-25 13:09:26 UTC (rev 5153)
+++ trunk/fs/src/driver/org/jnode/driver/block/scsi/cdrom/SCSICDROMDriver.java 2009-03-25 14:02:21 UTC (rev 5154)
@@ -55,9 +55,6 @@
this.blockAlignment = new FSBlockAlignmentSupport(this, 2048);
}
- /**
- * @see org.jnode.driver.Driver#startDevice()
- */
protected void startDevice() throws DriverException {
this.locked = false;
this.changed = true;
@@ -70,9 +67,6 @@
dev.registerAPI(FSBlockDeviceAPI.class, blockAlignment);
}
- /**
- * @see org.jnode.driver.Driver#stopDevice()
- */
protected void stopDevice() throws DriverException {
try {
unlock();
@@ -86,39 +80,24 @@
}
}
- /**
- * @see org.jnode.driver.block.FSBlockDeviceAPI#getPartitionTableEntry()
- */
public PartitionTableEntry getPartitionTableEntry() {
return null;
}
- /**
- * @see org.jnode.driver.block.FSBlockDeviceAPI#getSectorSize()
- */
public int getSectorSize() throws IOException {
processChanged();
return capacity.getBlockLength();
}
- /**
- * @see org.jnode.driver.block.BlockDeviceAPI#flush()
- */
public void flush() throws IOException {
// Do nothing
}
- /**
- * @see org.jnode.driver.block.BlockDeviceAPI#getLength()
- */
public long getLength() throws IOException {
processChanged();
return capacity.getBlockLength() & capacity.getLogicalBlockAddress();
}
- /**
- * @see org.jnode.driver.block.BlockDeviceAPI#read(long, byte[], int, int)
- */
public void read(long devOffset, ByteBuffer destBuf)
throws IOException {
//TODO optimize it also to use ByteBuffer at lower level
@@ -152,9 +131,6 @@
destBA.refreshByteBuffer();
}
- /**
- * @see org.jnode.driver.block.BlockDeviceAPI#write(long, byte[], int, int)
- */
public void write(long devOffset, ByteBuffer src)
throws IOException {
throw new IOException("Readonly device");
@@ -163,7 +139,7 @@
/**
* Can this device be locked.
*
- * @return
+ * @return {@code true} if the device can be locked, otherwise {@code false}.
*/
public boolean canLock() {
return true;
@@ -172,7 +148,7 @@
/**
* Can this device be ejected.
*
- * @return
+ * @return {@code true} if the device can be ejected, otherwise {@code false}.
*/
public boolean canEject() {
return true;
Modified: trunk/gui/src/awt/org/jnode/awt/JNodeAwtContext.java
===================================================================
--- trunk/gui/src/awt/org/jnode/awt/JNodeAwtContext.java 2009-03-25 13:09:26 UTC (rev 5153)
+++ trunk/gui/src/awt/org/jnode/awt/JNodeAwtContext.java 2009-03-25 14:02:21 UTC (rev 5154)
@@ -33,14 +33,14 @@
/**
* Gets the desktop pane that holds all the Frames.
*
- * @return
+ * @return the desktop pane
*/
public JDesktopPane getDesktop();
/**
* Gets the root container of the screen, that holds the desktop.
*
- * @return
+ * @return the root container
*/
public JComponent getAwtRoot();
Modified: trunk/gui/src/awt/org/jnode/awt/JNodeGenericPeer.java
===================================================================
--- trunk/gui/src/awt/org/jnode/awt/JNodeGenericPeer.java 2009-03-25 13:09:26 UTC (rev 5153)
+++ trunk/gui/src/awt/org/jnode/awt/JNodeGenericPeer.java 2009-03-25 14:02:21 UTC (rev 5154)
@@ -36,7 +36,7 @@
}
/**
- * @return
+ * @return the target component
*/
public final compT getTargetComponent() {
return this.targetComponent;
Modified: trunk/gui/src/awt/org/jnode/awt/font/FontProvider.java
===================================================================
--- trunk/gui/src/awt/org/jnode/awt/font/FontProvider.java 2009-03-25 13:09:26 UTC (rev 5153)
+++ trunk/gui/src/awt/org/jnode/awt/font/FontProvider.java 2009-03-25 14:02:21 UTC (rev 5154)
@@ -87,25 +87,25 @@
* Translates the font into a font that is provided by this provider.
*
* @param font
- * @return
+ * @return the translated font
*/
public F getCompatibleFont(Font font);
/**
- * Creates a font peer from the given name or return null if not supported/provided.
+ * Creates a font peer from the given name or return {@code null} if not supported/provided.
* As said in {@link org.jnode.awt.JNodeToolkit#getClasspathFontPeer(String, java.util.Map)} javadoc :
* "We don't know what kind of "name" the user requested (logical, face, family)".
*
* @param name
* @param attrs
- * @return
+ * @return the font peer or {@code null}.
*/
public JNodeFontPeer<? extends FontProvider<F>, F> createFontPeer(String name, Map attrs);
/**
* Read and create a Font from the given InputStream
* @param stream
- * @return
+ * @return the font
*/
public F createFont(InputStream stream) throws FontFormatException, IOException;
}
Modified: trunk/gui/src/awt/org/jnode/awt/font/JNodeFontPeer.java
===================================================================
--- trunk/gui/src/awt/org/jnode/awt/font/JNodeFontPeer.java 2009-03-25 13:09:26 UTC (rev 5153)
+++ trunk/gui/src/awt/org/jnode/awt/font/JNodeFontPeer.java 2009-03-25 14:02:21 UTC (rev 5154)
@@ -53,15 +53,8 @@
this.provider = provider;
}
- /**
- * @see gnu.java.awt.peer.ClasspathFontPeer#canDisplay(java.awt.Font, char)
- */
public abstract boolean canDisplay(Font font, char c);
- /**
- * @see gnu.java.awt.peer.ClasspathFontPeer#canDisplayUpTo(java.awt.Font,
- * java.text.CharacterIterator, int, int)
- */
@Override
public final int canDisplayUpTo(Font font, CharacterIterator i, int start, int limit) {
int upTo = -1;
@@ -76,93 +69,41 @@
return upTo;
}
- /**
- * @see gnu.java.awt.peer.ClasspathFontPeer#createGlyphVector(java.awt.Font,
- * java.awt.font.FontRenderContext, java.text.CharacterIterator)
- */
@Override
public final GlyphVector createGlyphVector(Font font, FontRenderContext frc, CharacterIterator ci) {
return TGlyphVector.create(font, frc, ci);
}
- /**
- * @see gnu.java.awt.peer.ClasspathFontPeer#createGlyphVector(java.awt.Font,
- * java.awt.font.FontRenderContext, int[])
- */
@Override
public final GlyphVector createGlyphVector(Font font, FontRenderContext ctx,
int[] glyphCodes) {
return new StandardGlyphVector(font, glyphCodes, ctx);
}
- /**
- * @see gnu.java.awt.peer.ClasspathFontPeer#getBaselineFor(java.awt.Font,
- * char)
- */
public abstract byte getBaselineFor(Font font, char c);
- /**
- * @see gnu.java.awt.peer.ClasspathFontPeer#getFontMetrics(java.awt.Font)
- */
public abstract FontMetrics getFontMetrics(Font font);
- /**
- * @see gnu.java.awt.peer.ClasspathFontPeer#getGlyphName(java.awt.Font, int)
- */
public abstract String getGlyphName(Font font, int glyphIndex);
- /**
- * @see gnu.java.awt.peer.ClasspathFontPeer#getLineMetrics(java.awt.Font,
- * java.text.CharacterIterator, int, int,
- * java.awt.font.FontRenderContext)
- */
public abstract LineMetrics getLineMetrics(Font font, CharacterIterator ci,
int begin, int limit, FontRenderContext rc);
- /**
- * @see gnu.java.awt.peer.ClasspathFontPeer#getMaxCharBounds(java.awt.Font,
- * java.awt.font.FontRenderContext)
- */
public abstract Rectangle2D getMaxCharBounds(Font font, FontRenderContext rc);
- /**
- * @see gnu.java.awt.peer.ClasspathFontPeer#getMissingGlyphCode(java.awt.Font)
- */
public abstract int getMissingGlyphCode(Font font);
- /**
- * @see gnu.java.awt.peer.ClasspathFontPeer#getNumGlyphs(java.awt.Font)
- */
public abstract int getNumGlyphs(Font font);
- /**
- * @see gnu.java.awt.peer.ClasspathFontPeer#getPostScriptName(java.awt.Font)
- */
public abstract String getPostScriptName(Font font);
- /**
- * @see gnu.java.awt.peer.ClasspathFontPeer#getStringBounds(java.awt.Font,
- * java.text.CharacterIterator, int, int,
- * java.awt.font.FontRenderContext)
- */
public abstract Rectangle2D getStringBounds(Font font, CharacterIterator ci,
int begin, int limit, FontRenderContext frc);
- /**
- * @see gnu.java.awt.peer.ClasspathFontPeer#getSubFamilyName(java.awt.Font,
- * java.util.Locale)
- */
public abstract String getSubFamilyName(Font font, Locale locale);
- /**
- * @see gnu.java.awt.peer.ClasspathFontPeer#hasUniformLineMetrics(java.awt.Font)
- */
public abstract boolean hasUniformLineMetrics(Font font);
- /**
- * @see gnu.java.awt.peer.ClasspathFontPeer#layoutGlyphVector(java.awt.Font,
- * java.awt.font.FontRenderContext, char[], int, int, int)
- */
public abstract GlyphVector layoutGlyphVector(Font font, FontRenderContext frc,
char[] chars, int start, int limit, int flags);
@@ -174,7 +115,7 @@
* this peer's provider provides.
*
* @param font any instance of {@link Font} (might not be an instance of F)
- * @return
+ * @return the Font
*/
protected final F getCompatibleFont(Font font) {
return provider.getCompatibleFont(font);
Modified: trunk/gui/src/awt/org/jnode/awt/font/bdf/BDFFontProvider.java
===================================================================
--- trunk/gui/src/awt/org/jnode/awt/font/bdf/BDFFontProvider.java 2009-03-25 13:09:26 UTC (rev 5153)
+++ trunk/gui/src/awt/org/jnode/awt/font/bdf/BDFFontProvider.java 2009-03-25 14:02:21 UTC (rev 5154)
@@ -84,7 +84,7 @@
*
* @param name
* @param attrs
- * @return
+ * @return the font peer
*/
@Override
public BDFFontPeer createFontPeer(String name, Map attrs) {
@@ -114,7 +114,7 @@
* Read an create a Font from the given InputStream
*
* @param stream
- * @return
+ * @return the font
*/
@Override
public BDFFont createFont(InputStream stream) throws FontFormatException, IOException {
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
