Javadoc Fixes

This commit is contained in:
astrelsky 2019-11-25 23:41:54 -05:00
parent 9a470a9dc7
commit ebde7cd6d2
No known key found for this signature in database
GPG key ID: FA88FA97D6877C37
659 changed files with 1690 additions and 3968 deletions

View file

@ -25,7 +25,7 @@ public interface GEdge<V> {
/**
* Get the start, or tail, of the edge
*
* <P>In the edge x -> y, x is the start
* <P>In the edge x -&gt; y, x is the start
*
* @return the start
*/
@ -34,7 +34,7 @@ public interface GEdge<V> {
/**
* Get the end, or head, of the edge
*
* <P>In the edge x -> y, y is the end
* <P>In the edge x -&gt; y, y is the end
*
* @return the end
*/

View file

@ -35,8 +35,8 @@ public interface GImplicitDirectedGraph<V, E extends GEdge<V>> {
*
* (Optional operation)
*
* @note This method ought to return cached results if available
* @note As part of computing in-edges, this method will also provide predecessors
* NOTE: This method ought to return cached results if available
* NOTE: As part of computing in-edges, this method will also provide predecessors
*
* @param v the destination vertex
* @return the in-edges to the given vertex
@ -46,8 +46,8 @@ public interface GImplicitDirectedGraph<V, E extends GEdge<V>> {
/**
* Compute the incident edges that start at the given vertex
*
* @note This method ought to return cached results if available
* @note As part of computing out-edges, this method will also provide successors
* NOTE: This method ought to return cached results if available
* NOTE: As part of computing out-edges, this method will also provide successors
*
* @param v the source vertex
* @return the out-edges from the given vertex
@ -59,7 +59,7 @@ public interface GImplicitDirectedGraph<V, E extends GEdge<V>> {
*
* The default implementation computes this from the in-edges
*
* @note If a non-default implementation is provided, it ought to return cached results if
* NOTE: If a non-default implementation is provided, it ought to return cached results if
* available
*
* @param v the destination vertex
@ -78,7 +78,7 @@ public interface GImplicitDirectedGraph<V, E extends GEdge<V>> {
*
* The default implementation compute this from the out-edges
*
* @note If a non-default implementation is provided, it ought to return cached results if
* NOTE: If a non-default implementation is provided, it ought to return cached results if
* available
*
* @param v the source vertex

View file

@ -18,7 +18,7 @@ package ghidra.graph;
/**
* An edge having a natural weight
*
* param <V> the type of vertices
* @param <V> the type of vertices
*/
public interface GWeightedEdge<V> extends GEdge<V> {
/**

View file

@ -60,7 +60,6 @@ public class DijkstraShortestPathsAlgorithm<V, E extends GEdge<V>> {
* likely encounter a {@link ClassCastException}.
*
* @param graph the graph
* @param maxDistance the maximum distance, or null for no maximum
*/
public DijkstraShortestPathsAlgorithm(GImplicitDirectedGraph<V, E> graph) {
this.graph = graph;
@ -87,7 +86,6 @@ public class DijkstraShortestPathsAlgorithm<V, E extends GEdge<V>> {
* Use Dijstra's algorithm on the given graph with a custom edge weight metric
*
* @param graph the graph
* @param maxDistance the maximum distance, or null for no maximum
* @param metric the function to compute the weight of an edge
*/
public DijkstraShortestPathsAlgorithm(GImplicitDirectedGraph<V, E> graph,

View file

@ -37,14 +37,14 @@ public interface VisualGraphChangeListener<V, E> {
/**
* Called when the given edges have been added from the graph
*
* @param vertices the added edges
* @param edges the added edges
*/
public void edgesAdded(Iterable<E> edges);
/**
* Called when the given edges have been removed from the graph
*
* @param vertices the removed edges
* @param edges the removed edges
*/
public void edgesRemoved(Iterable<E> edges);
}

View file

@ -50,7 +50,7 @@ public interface VisualGraphFeaturette<V extends VisualVertex,
* Called when the client wishes to restore configuration state. Features can read state
* previously saved from a call to {@link #writeConfigState(SaveState)}.
*
* @param state the container for state information
* @param saveState the container for state information
*/
public void readConfigState(SaveState saveState);

View file

@ -135,7 +135,7 @@ public interface VisualVertex extends GVertex {
* Set the alpha, which determines how much of the vertex is visible/see through. 0 is
* completely transparent. This attribute allows transitional for animations.
*
* @param the alpha value
* @param alpha the alpha value
*/
public void setAlpha(double alpha);

View file

@ -44,9 +44,9 @@ import ghidra.graph.viewer.vertex.VisualGraphVertexShapeTransformer;
/**
* Edge render for the {@link VisualGraph} system
*
* <h3><center>Implementation Notes</center></h3>
* <h2><center>Implementation Notes</center></h2>
*
* <h4>Jung Vertex/Edge Rendering</h4>
* <h3>Jung Vertex/Edge Rendering</h3>
* <p>Jung creates shapes for vertices (see {@link VertexShapeFactory}) that are centered. They
* do this by getting the width/height of the shape and then creating an x/y value that is
* half of the width and height, respectively. This has the effect of the vertex appearing
@ -55,7 +55,7 @@ import ghidra.graph.viewer.vertex.VisualGraphVertexShapeTransformer;
* Jung's.
* <p>If we ever decide instead to not center our shapes, then this renderer would have to be
* updated to itself center the edge shape created herein, like this:
* <pre>
* <pre>{@literal
* Rectangle b1 = s1.getBounds();
* Rectangle b2 = s2.getBounds();
*
@ -70,7 +70,7 @@ import ghidra.graph.viewer.vertex.VisualGraphVertexShapeTransformer;
* float tx2 = x2 + w2;
* float ty2 = y2 + h2;
* Shape edgeShape = getEdgeShape(rc, graph, e, tx1, ty1, tx2, ty2, isLoop, xs1);
* </pre>
* }</pre>
* <p>Also, there are other spots in the system where we account for this center that would
* have to be changed, such as the {@link AbstractVisualGraphLayout}, which needs the centering
* offsets to handle vertex clipping.

View file

@ -29,7 +29,7 @@ import org.apache.commons.collections4.map.LazyMap;
* class are row, column grid values, starting at 0,0.
*
* <P>Note: the Point2D values for the edge articulations use x,y values that are row and
* column index values, the same values as calling {@link #row(V)} and {@link #col(V)}.
* column index values, the same values as calling {@link #row(Object) row(V)} and {@link #col(Object) col(V)}.
*
* <P>After building the grid using this class, clients can call {@link #rows()} to get
* high-order object that represent rows.

View file

@ -29,7 +29,7 @@ import ghidra.graph.viewer.GraphViewerUtils;
* of a grid.
*
* <p>This class maintains a collection of vertices on this row, organized by column index. You
* can get the column of a vertex from {@link #getColumn(V)}.
* can get the column of a vertex from {@link #getColumn(Object) getColumn(V)}.
*/
public class Row<V> {
@ -131,7 +131,7 @@ public class Row<V> {
* Returns all vertices in this row, sorted by column index (min to max).
*
* <p>Note: the index of a vertex in the list does not match the column index. To get the
* column index for a vertex, call {@link #getColumn(V)}.
* column index for a vertex, call {@link #getColumn(Object) getColumn(V)}.
*
* @return all vertices in this row
*/

View file

@ -34,7 +34,6 @@ import ghidra.util.task.TaskMonitor;
*
* @param <V> the vertex type
* @param <E> the edge type
* @param <G> the graph type
*/
//@formatter:off
public interface VisualGraphLayout<V extends VisualVertex,
@ -64,10 +63,9 @@ public interface VisualGraphLayout<V extends VisualVertex,
* need not loop over all edges to determine if they have articulations. (Looping over
* large graphs is time intensive.)
*
* <P>{@link VisualEdge#articulations What are articulations?}</A>
* <P><A HREF="../VisualEdge.html#articulations">What are articulations?</A>
*
* @return true if this layout uses articulated edges.
* @see ArticulatedEdge
*/
public boolean usesEdgeArticulations();

View file

@ -19,7 +19,6 @@ package ghidra.graph.viewer.vertex;
* A listener called when a vertex is focused.
*
* @param <V> the vertex type
* @param <E> the edge type
*/
public interface VertexFocusListener<V> {

View file

@ -53,7 +53,7 @@ public class VisualGraphVertexShapeTransformer<V extends VisualVertex>
* Returns the full (the actual) shape of a vertex. This can be used to determine if a
* mouse point intersects a vertex or to get the real bounding-box of a vertex.
*
* @param the vertex
* @param v the vertex
* @return the shape
*/
public Shape transformToFullShape(V v) {