Skip to content

Commit

Permalink
Fix all reported JavaDoc errors
Browse files Browse the repository at this point in the history
This also repairs the Zest JavaDoc generation and includes the CloudIO
component.
  • Loading branch information
ptziegler committed Dec 27, 2024
1 parent 0bd5f17 commit 55a3204
Show file tree
Hide file tree
Showing 43 changed files with 241 additions and 194 deletions.
10 changes: 8 additions & 2 deletions org.eclipse.draw2d.doc.isv/javadocOptions.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,15 @@
-windowtitle "Draw2d API Specification"
-doctitle "Draw2d API Specification"
-header "<b>Draw2d</b><br>@build@"
-bottom "Copyright (c) IBM Corp. and others 2000, 2011. All Rights Reserved."
-link http://docs.oracle.com/javase/1.4.2/docs/api/
-bottom "Copyright (c) IBM Corp. and others 2000, 2024. All Rights Reserved."
-link https://docs.oracle.com/en/java/javase/17/
-linkoffline PLUGINS_ROOT/org.eclipse.platform.doc.isv/reference/api @linkoffline-target@/org.eclipse.platform.doc.isv/reference/api
-tag noextend:t:"@noextend"
-tag noimplement:t:"@noimplement"
-tag nooverride:m:"@nooverride"
-tag noreference:tcmf:"@noreference"
-tag noinstantiate:t:"@noinstantiate"
-tag TODO:a:"TODO"

org.eclipse.draw2d
org.eclipse.draw2d.geometry
Expand Down
2 changes: 1 addition & 1 deletion org.eclipse.draw2d/src/org/eclipse/draw2d/Animation.java
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ public static Object getInitialState(Animator animator, IFigure figure) {
}

/**
* Returns the animation progress, where 0.0 < progress &#8804; 1.0.
* Returns the animation progress, where 0.0 &lt; progress &#8804; 1.0.
*
* @return the progress of the animation
* @since 3.2
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ public void route(Connection conn) {
* Sets the constraint for the given {@link Connection}.
*
* @param connection The connection whose constraint we are setting
* @param constraint The constraint, which as to be a List<Bendpoint>
* @param constraint The constraint, which as to be a List&lt;Bendpoint&gt;
*/
@SuppressWarnings("unchecked")
@Override
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
*
*
* <pre>
* |<----extent--->|
* |&lt;----extent---&gt;|
* ----|-----------|---------------|---------------|----
* min | max
* value
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
/**
* A scrolling Canvas that contains {@link Figure Figures} viewed through a
* {@link Viewport}. Call {@link #setContents(IFigure)} to specify the root of
* the tree of <tt>Figures</tt> to be viewed through the <tt>Viewport</tt>.
* the tree of {@link Figure Figures} to be viewed through the {@link Viewport}.
* <p>
* Normal procedure for using a FigureCanvas:
* <ol>
Expand Down
4 changes: 3 additions & 1 deletion org.eclipse.draw2d/src/org/eclipse/draw2d/GridData.java
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
* <p>
* There are two ways to create a <code>GridData</code> object with certain
* fields set. The first is to set the fields directly, like this:
* </p>
*
* <pre>
* GridData gridData = new GridData();
Expand All @@ -36,14 +37,15 @@
* myGridlayout.setConstraint(myFigure, gridData);
* </pre>
*
* <p>
* The second is to take advantage of convenience style bits defined by
* <code>GridData</code>:
* </p>
*
* <pre>
* GridData gridData = new GridData(GridData.HORIZONTAL_ALIGN_FILL | GridData.GRAB_HORIZONTAL);
* </pre>
*
* </p>
* <p>
* NOTE: Do not reuse <code>GridData</code> objects. Every child in the parent
* <code>Figure</code> that is managed by the <code>GridLayout</code> must have
Expand Down
2 changes: 1 addition & 1 deletion org.eclipse.draw2d/src/org/eclipse/draw2d/GridLayout.java
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@
* The <code>numColumns</code> field is the most important field in a
* <code>GridLayout</code>. Widgets are laid out in columns from left to right,
* and a new row is created when <code>numColumns</code>+ 1 figures are added to
* the <code>Figure<code> parent container.
* the <code>Figure</code> parent container.
*
* @see GridData
*
Expand Down
2 changes: 1 addition & 1 deletion org.eclipse.draw2d/src/org/eclipse/draw2d/IFigure.java
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
public interface IFigure {

/**
* Insets that are all 0. Always returns <code>true<code> for
* Insets that are all 0. Always returns <code>true</code> for
* {@link #isEmpty()}.
*/
class NoInsets extends Insets {
Expand Down
16 changes: 8 additions & 8 deletions org.eclipse.draw2d/src/org/eclipse/draw2d/OrderedLayout.java
Original file line number Diff line number Diff line change
Expand Up @@ -116,10 +116,10 @@ public boolean isHorizontal() {
*
* @return whether children are to be stretched in the minor axis.
*
* @TODO: Made abstract here, so that derived layout managers can guarantee
* backwards compatibility for their exposed fields. Can be made concrete
* in the next major release, removing implementations in the derived
* layout managers.
* @TODO Made abstract here, so that derived layout managers can guarantee
* backwards compatibility for their exposed fields. Can be made concrete
* in the next major release, removing implementations in the derived
* layout managers.
*/
public abstract boolean isStretchMinorAxis();

Expand Down Expand Up @@ -157,10 +157,10 @@ public void setMinorAlignment(int align) {
* width.
*
* @param value whether children should be stretched in the minor axis.
* @TODO: Made abstract here, so that derived layout managers can guarantee
* backwards compatibility for their exposed fields. Can be made concrete
* in the next major release, removing implementations in the derived
* layout managers.
* @TODO Made abstract here, so that derived layout managers can guarantee
* backwards compatibility for their exposed fields. Can be made concrete
* in the next major release, removing implementations in the derived
* layout managers.
*/
public abstract void setStretchMinorAxis(boolean value);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@
* <LI>A {@link DelegatingLayout} is set as the default layout. A delegating
* layout allows children to position themselves via {@link Locator Locators}.
* </UL>
* <P>
*/
public class PolylineConnection extends Polyline implements Connection, AnchorListener {

Expand Down
15 changes: 8 additions & 7 deletions org.eclipse.draw2d/src/org/eclipse/draw2d/PositionConstants.java
Original file line number Diff line number Diff line change
Expand Up @@ -15,19 +15,20 @@
/**
* Constants representing cardinal directions and relative positions. Some of
* these constants can be grouped as follows:
* <TABLE border="1" cellpadding="5" cellspacing="0">
* <TABLE border="1" style="border-spacing: 0px">
* <CAPTION></CAPTION>
* <TBODY>
* <TR>
* <TD>LEFT, CENTER, RIGHT</TD>
* <TD>Used to describe horizontal position.</TD>
* <TD style="padding: 5px">LEFT, CENTER, RIGHT</TD>
* <TD style="padding: 5px">Used to describe horizontal position.</TD>
* </TR>
* <TR>
* <TD>TOP, MIDDLE, BOTTOM</TD>
* <TD>Used to describe vertical position.</TD>
* <TD style="padding: 5px">TOP, MIDDLE, BOTTOM</TD>
* <TD style="padding: 5px">Used to describe vertical position.</TD>
* </TR>
* <TR>
* <TD>NORTH, SOUTH, EAST, WEST</TD>
* <TD>Used to describe the four positions relative to an object's center point.
* <TD style="padding: 5px">NORTH, SOUTH, EAST, WEST</TD>
* <TD style="padding: 5px">Used to describe the four positions relative to an object's center point.
* May also be used when describing which direction an object is facing.<BR>
* NOTE: If you have a use for all four of these possibilities, do not use TOP,
* BOTTOM, RIGHT, LEFT in place of NORTH, SOUTH, EAST, WEST.</TD>
Expand Down
4 changes: 3 additions & 1 deletion org.eclipse.draw2d/src/org/eclipse/draw2d/SWTGraphics.java
Original file line number Diff line number Diff line change
Expand Up @@ -1144,8 +1144,10 @@ public void setClip(Path path) {
/**
* Simple implementation of clipping a Path within the context of current
* clipping rectangle for now (not region)
* <ul>
* <li>Note that this method wipes out the clipping rectangle area, hence if
* clients need to reset it call {@link #restoreState()}
* clients need to reset it call {@link #restoreState()}</li>
* </ul>
*
* @see org.eclipse.draw2d.Graphics#clipPath(org.eclipse.swt.graphics.Path)
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ public int getDescent(Font font) {

/**
* Returns the largest substring of <i>s</i> in Font <i>f</i> that can be
* confined to the number of pixels in <i>availableWidth<i>.
* confined to the number of pixels in <i>availableWidth</i>.
*
* @param s the original string
* @param f the font
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ public interface UpdateListener {
void notifyValidating();

/**
* An empty implementation of {@list UpdateListener} for convenience.
* An empty implementation of {@link UpdateListener} for convenience.
*
* @since 3.16
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -129,8 +129,8 @@ public boolean contains(Dimension d) {

/**
* Returns <code>true</code> if this Dimension properly contains the one
* specified. Proper containment is defined as containment using \"<\", instead
* of \"<=\".
* specified. Proper containment is defined as containment using \"&lt;\",
* instead of \"&lt;=\".
*
* @param d the dimension being tested
* @return <code>true</code> if this Dimension properly contains the one
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@
* @author mitin_aa
* @author lobas_av
* @author scheglov_ke
* @coverage gef.draw2d
* @since 3.13
*/
public record Interval(int begin, int length) implements Serializable {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
* completes, it will invert the edges again, but will leave the feedback flags
* set.
* <LI>for each node <em>n</em>, assign n to a "rank" R(n), such that: for each
* edge (m, n) in n.incoming, R(m)<=R(n)-(m,n).delta. The total weighted edge
* edge (m, n) in n.incoming, R(m)&lt;=R(n)-(m,n).delta. The total weighted edge
* lengths shall be no greater than is necessary to meet this requirement for
* all edges in the graph.
* <LI>attempt to order the nodes in their ranks as to minimize crossings.
Expand Down
9 changes: 7 additions & 2 deletions org.eclipse.gef.doc.isv/javadocOptions.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,15 @@
-windowtitle "GEF (MVC) API Specification"
-doctitle "GEF (MVC) API Specification"
-header "<b>GEF (MVC)</b><br>@build@"
-bottom "Copyright (c) IBM Corp. and others 2000, 2011. All Rights Reserved."
-link http://docs.oracle.com/javase/1.4.2/docs/api/
-bottom "Copyright (c) IBM Corp. and others 2000, 2024. All Rights Reserved."
-link https://docs.oracle.com/en/java/javase/17/
-linkoffline PLUGINS_ROOT/org.eclipse.platform.doc.isv/reference/api/ @linkoffline-target@/org.eclipse.platform.doc.isv/reference/api/
-linkoffline PLUGINS_ROOT/org.eclipse.draw2d.doc.isv/reference/api/ ../org.eclipse.draw2d.doc.isv/reference/api/
-tag noextend:t:"@noextend"
-tag noimplement:t:"@noimplement"
-tag nooverride:m:"@nooverride"
-tag noreference:tcmf:"@noreference"
-tag noinstantiate:t:"@noinstantiate"

org.eclipse.gef
org.eclipse.gef.commands
Expand Down
16 changes: 9 additions & 7 deletions org.eclipse.gef/src/org/eclipse/gef/EditPart.java
Original file line number Diff line number Diff line change
Expand Up @@ -336,8 +336,9 @@ public interface EditPart extends IAdaptable {
void setFocus(boolean hasFocus);

/**
* <img src="doc-files/dblack.gif"/>Sets the model. This method is made public
* to facilitate the use of {@link EditPartFactory EditPartFactories} .
* <img src="doc-files/dblack.gif" alt="&#9670;&#9670;"/>Sets the model. This
* method is made public to facilitate the use of {@link EditPartFactory
* EditPartFactories} .
*
* <P>
* IMPORTANT: This method should only be called once.
Expand All @@ -347,17 +348,18 @@ public interface EditPart extends IAdaptable {
void setModel(Object model);

/**
* <img src="doc-files/dblack.gif"/>Sets the parent. This should only be called
* by the parent EditPart.
* <img src="doc-files/dblack.gif" alt="&#9670;&#9670;"/>Sets the parent. This
* should only be called by the parent EditPart.
*
* @param parent the parent EditPart
*/
void setParent(EditPart parent);

/**
* <img src="doc-files/dblack.gif"/> Sets the selected state property to reflect
* the selection in the EditPartViewer. Fires selectedStateChanged(EditPart) to
* any EditPartListeners. Selection is maintained by the EditPartViewer.
* <img src="doc-files/dblack.gif" alt="&#9670;&#9670;"/> Sets the selected
* state property to reflect the selection in the EditPartViewer. Fires
* selectedStateChanged(EditPart) to any EditPartListeners. Selection is
* maintained by the EditPartViewer.
* <P>
* IMPORTANT: This method should only be called by the EditPartViewer.
*
Expand Down
16 changes: 10 additions & 6 deletions org.eclipse.gef/src/org/eclipse/gef/Tool.java
Original file line number Diff line number Diff line change
Expand Up @@ -34,22 +34,26 @@
* perform the User's operation. Using Requests, Tools will:
* <UL>
* <LI>Ask EditParts for {@link org.eclipse.gef.commands.Command Commands} to
* perform changes on the model.
* <LI>Ask EditParts to show and erase feedback during an operation.
* <LI>Ask EditParts to perform a generic function, using
* {@link org.eclipse.gef.EditPart#performRequest(Request)}.
* perform changes on the model.</LI>
* <LI>Ask EditParts to show and erase feedback during an operation.</LI>
* <LI>Ask EditParts to perform a generic function, using</LI>
* {@link org.eclipse.gef.EditPart#performRequest(Request)}
* </UL>
* <P>
* Tools also perform operations that do not involve the EditParts directly,
* such as changing the Viewer's selection, scrolling the viewer, or invoking an
* {@link org.eclipse.jface.action.IAction Action}.
* <table>
* <caption></caption>
* <tr>
* <td valign=top><img src="doc-files/important.gif"/>
* <td style="vertical-align:top"><img src="doc-files/important.gif" alt=
* "Important!"/>
* <td>All feedback should be erased and temporary changes reverted prior to
* executing any command.
* </tr>
* <tr>
* <td valign=top><img src="doc-files/important.gif"/>
* <td style="vertical-align:top"><img src="doc-files/important.gif" alt=
* "Important!"/>
* <td>Tools should process most keystrokes. For example, the DELETE key should
* <EM>not</EM> be handled by adding a KeyListener to the Viewer's Control.
* Doing so would mean that pressing DELETE would <EM>not</EM> be sensitive to
Expand Down
6 changes: 3 additions & 3 deletions org.eclipse.gef/src/org/eclipse/gef/doc-files/mvc.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<body>
<h1>Model-View-Controller Architecture</h1>
<h3>
<img border="0" src="org/eclipse/gef/doc-files/mvc-generic.gif" width="249" height="177"></h3>
<h2>
<img style="border:0px" src="org/eclipse/gef/doc-files/mvc-generic.gif" alt="Model-View-Controller Relationship" width="249" height="177"></h2>
<h3>Model</h3>
<p>The <i>model</i> portion is somewhat self-explanatory.&nbsp; The model should
know nothing about the view or controller.&nbsp; It does however usually know
Expand Down Expand Up @@ -31,5 +31,5 @@ <h3>Controller</h3>
and easier code maintenance.</p>
<p>A controller in GEF is an {@link org.eclipse.gef.EditPart EditPart}.</p>
<p>
<img border="0" src="org/eclipse/gef/doc-files/mvc-gef.gif" width="438" height="380"></p>
<img style="border:0px" src="org/eclipse/gef/doc-files/mvc-gef.gif" alt="Model-View-Controller Relationship" width="438" height="380"></p>
</body>
Loading

0 comments on commit 55a3204

Please sign in to comment.