Update JavaDoc, also constraint should be ring size < 8.

johnmay · johnmay · commit 36f29ce27ee2 · 2019-07-31T09:42:44.000+01:00
diff --git a/display/renderbasic/src/main/java/org/openscience/cdk/renderer/generators/standard/StandardDonutGenerator.java b/display/renderbasic/src/main/java/org/openscience/cdk/renderer/generators/standard/StandardDonutGenerator.java
@@ -46,6 +46,14 @@
 
 import static org.openscience.cdk.interfaces.IBond.Order.UNSET;
 
+/**
+ * Generates aromatic donuts (or life buoys) as ovals in small (<8) aromatic
+ * rings. If the ring is charged (and the charged is not shared with another
+ * ring, e.g. rbonds > 2) it will be depicted in the middle of the ring.
+ *
+ * @see ForceDelocalisedBondDisplay
+ * @see DelocalisedDonutsBondDisplay
+ */
 final class StandardDonutGenerator {
 
     // bonds involved in donuts!
@@ -63,7 +71,13 @@ final class StandardDonutGenerator {
     private final Font       font;
     private final IAtomContainer mol;
 
-    public StandardDonutGenerator(IAtomContainer mol, Font font, RendererModel model) {
+    /**
+     * Create a new generator for a molecule.
+     * @param mol molecule
+     * @param font the font
+     * @param model the rendering parameters
+     */
+    StandardDonutGenerator(IAtomContainer mol, Font font, RendererModel model) {
         this.mol = mol;
         this.font = font;
         this.forceDelocalised = model.get(ForceDelocalisedBondDisplay.class);
@@ -75,7 +89,7 @@ public StandardDonutGenerator(IAtomContainer mol, Font font, RendererModel model
     }
 
     private boolean canDelocalise(final IAtomContainer ring) {
-        boolean okay = ring.getBondCount() <= 8;
+        boolean okay = ring.getBondCount() < 8;
         if (!okay)
             return false;
         for (IBond bond : ring.bonds()) {
diff --git a/display/renderbasic/src/main/java/org/openscience/cdk/renderer/generators/standard/StandardGenerator.java b/display/renderbasic/src/main/java/org/openscience/cdk/renderer/generators/standard/StandardGenerator.java
@@ -1156,13 +1156,16 @@ public Boolean getDefault() {
      * there is a valid Kekule structure. Delocalised bonds will either be
      * rendered as a dashed bond to the side or as a circle/donut/life buoy
      * inside small rings. This depiction is used by default when a bond does
-     * not have an order assigned (e.g. null/unset). Turning this option on
-     * means all delocalised bonds will be rendered this way.
+     * not have an order assigned (e.g. null/unset), for example: c1cccc1.
+     * Turning this option on means all delocalised bonds will be rendered this
+     * way even when they have bond orders correctly assigned: e.g. c1ccccc1,
+     * [cH-]1cccc1.
      * <br>
      * <b>As recommended by IUPAC, their usage is discouraged and the Kekule
      * representation is more clear.</b>
      */
-    public static final class ForceDelocalisedBondDisplay extends AbstractGeneratorParameter<Boolean> {
+    public static final class ForceDelocalisedBondDisplay
+            extends AbstractGeneratorParameter<Boolean> {
 
         /**{@inheritDoc} */
         @Override
@@ -1175,7 +1178,8 @@ public Boolean getDefault() {
      * Render small delocalised rings as bonds/life buoys? This can sometimes
      * be misleading for fused rings but is commonly used.
      */
-    public static final class DelocalisedDonutsBondDisplay extends AbstractGeneratorParameter<Boolean> {
+    public static final class DelocalisedDonutsBondDisplay
+            extends AbstractGeneratorParameter<Boolean> {
 
         /**{@inheritDoc} */
         @Override
