summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorTom Tromey <tromey@redhat.com>2006-03-22 19:15:21 +0000
committerTom Tromey <tromey@redhat.com>2006-03-22 19:15:21 +0000
commit9423e1219970a3ab3a512db5de4370353fd23e52 (patch)
tree0c97ada3a122bf7ccba26677800b6c08eaa51d6e /doc
parent0792160f6f68079af01258b1a5b9bb363a031c8a (diff)
downloadclasspath-9423e1219970a3ab3a512db5de4370353fd23e52.tar.gz
* doc/hacking.texinfo (Source Code Style Guide): Mention
NotImplementedException. * javax/imageio/stream/MemoryCacheImageOutputStream.java (flushBefore): Mark as stub. (read): Likewise. * javax/imageio/stream/MemoryCacheImageInputStream.java (flushBefore): Mark as stub. * javax/imageio/stream/ImageOutputStreamImpl.java (flushBits): Mark as stub. (write): Likewise. (writeBit): Likewise. (writeChars): Likewise. (writeUTF): Likewise. * javax/imageio/stream/FileCacheImageOutputStream.java (read): Mark as stub. (read): Likewise. * java/net/URLConnection.java (getContent): Mark as stub. * java/awt/Window.java (applyResourceBundle): Mark as stub. * java/awt/TexturePaint.java (createContext): Mark as stub. (getTransparency): Mark as stub. * java/awt/ScrollPaneAdjustable.java (paramString): Mark as stub. * java/awt/GridBagLayout.java (AdjustForGravity): Mark as stub. * java/awt/GraphicsConfiguration.java (getBufferCapabilities): Mark as stub. (getImageCapabilities): Likewise. * java/awt/BasicStroke.java (createStrokedShape): Mark as stub. * java/awt/AlphaComposite.java (createContext): Mark as stub. * java/awt/image/renderable/RenderableImageProducer.java: Mark all methods as stubs. * java/awt/font/TextMeasurer.java (deleteChar): Mark as stub. (getAdvanceBetween): Likewise. (getLayout): Likewise. (insertChar): Likewise. (getLineBreakIndex): Likewise. * java/awt/font/ShapeGraphicAttribute.java (draw): Mark as stub. (getAdvance): Likewise. (getAscent): Likewise. (getDescent): Likewise. * java/awt/font/LineBreakMeasurer.java (deleteChar): Mark as stub. (insertChar): Likewise. (nextLayout): Likewise. (nextLayout): Likewise. (nextOffset): Likewise. (nextOffset): Likewise. * java/awt/font/ImageGraphicAttribute.java (draw): Mark as stub. (equals): Likewise. (getAdvance): Likewise. (getAscent): Likewise. (getBounds): Likewise. (getDescent): Likewise. (hashCode): Likewise. (ImageGraphicAttribute): Likewise. * java/awt/font/GraphicAttribute.java (getBounds): Mark as stub. (getJustificationInfo): Likewise. * java/awt/font/GlyphVector.java (getGlyphCharIndex): Mark as stub. (getGlyphCharIndices): Likewise. (getGlyphOutline): Likewise. (getGlyphPixelBounds): Likewise. (getLayoutFlags): Likewise. (getPixelBounds): Likewise. * java/awt/font/GlyphMetrics.java (getLSB): Mark as stub. (getRSB): Likewise. * java/nio/channels/Channels.java (newWriter): Mark as stub. * java/awt/dnd/DragSourceContext.java: Marked most methods as stubs. * java/awt/dnd/DragGestureRecognizer.java (fireDragGestureRecognized): Mark as stub. (resetRecognizer): Likewise. * java/awt/datatransfer/SystemFlavorMap.java (getFlavorsForNative): Mark as stub. (getNativesForFlavor): Likewise. * javax/swing/plaf/synth/SynthStyle.java: Mark all methods as stub.s * javax/swing/plaf/synth/SynthLookAndFeel.java (updateStyles): Mark as stub. (getRegion): Likewise. (createUI): Likewise. (initialize): Likewise. (uninitialize): Likewise. (getDefaults): Likewise. (load): Likewise. (shouldUpdateStyleOnAncestorChanged): Likewise. * javax/swing/plaf/synth/SynthGraphicsUtils.java (getMinimumSize): Mark as stub. (getPreferredSize): Likewise. (getMaximumSize): Likewise. (paintText): Likewise. * java/text/RuleBasedCollator.java (getCollationElementIterator): Mark as stub. * java/text/Collator.java (getAvailableLocales): Mark as stub.
Diffstat (limited to 'doc')
-rw-r--r--doc/hacking.texinfo6
1 files changed, 5 insertions, 1 deletions
diff --git a/doc/hacking.texinfo b/doc/hacking.texinfo
index 34b1099fd..efb7aa903 100644
--- a/doc/hacking.texinfo
+++ b/doc/hacking.texinfo
@@ -653,7 +653,11 @@ have @code{serialVersionUID} declared.
@item
Don't declare unchecked exceptions in the @code{throws} clause of a
method. However, if throwing an unchecked exception is part of the
-method's API, you should mention it in the Javadoc.
+method's API, you should mention it in the Javadoc. There is one
+important exception to this rule, which is that a stub method should
+be marked as throwing @code{gnu.classpath.NotImplementedException}.
+This will let our API comparison tools note that the method is not
+fully implemented.
@item
When overriding @code{Object.equals}, remember that @code{instanceof}