Fixed the 100+ javadoc warnings
This commit is contained in:
Andras Fuchs
parent
5b4b5d784c
commit
09d6435803
|
|
@ -708,7 +708,7 @@ public class BasicBoard implements java.io.Serializable
|
|||
/**
|
||||
* Combines the connected traces of this net, which have only 1 contact
|
||||
* at the connection point.
|
||||
* if p_net_no < 0 traces of all nets are combined.
|
||||
* if p_net_no {@literal <} 0 traces of all nets are combined.
|
||||
*/
|
||||
public boolean combine_traces(int p_net_no)
|
||||
{
|
||||
|
|
@ -848,7 +848,7 @@ public class BasicBoard implements java.io.Serializable
|
|||
|
||||
/**
|
||||
* Returns all SearchTreeObjects on layer p_layer, which overlap with p_shape.
|
||||
* If p_layer < 0, the layer is ignored
|
||||
* If p_layer {@literal <} 0, the layer is ignored
|
||||
*/
|
||||
public Set<SearchTreeObject> overlapping_objects(ConvexShape p_shape, int p_layer)
|
||||
{
|
||||
|
|
@ -862,7 +862,7 @@ public class BasicBoard implements java.io.Serializable
|
|||
* which describes the required clearance restrictions to other items.
|
||||
* The function may also return items, which are nearly overlapping,
|
||||
* but do not overlap with exact calculation.
|
||||
* If p_layer < 0, the layer is ignored.
|
||||
* If p_layer {@literal <} 0, the layer is ignored.
|
||||
*/
|
||||
public Set<Item> overlapping_items_with_clearance(ConvexShape p_shape, int p_layer, int[] p_ignore_net_nos,
|
||||
int p_clearance_class)
|
||||
|
|
@ -873,7 +873,7 @@ public class BasicBoard implements java.io.Serializable
|
|||
|
||||
/**
|
||||
* Returns all items on layer p_layer, which overlap with p_area.
|
||||
* If p_layer < 0, the layer is ignored
|
||||
* If p_layer {@literal <} 0, the layer is ignored
|
||||
*/
|
||||
public Set<Item> overlapping_items(Area p_area, int p_layer)
|
||||
{
|
||||
|
|
@ -1085,7 +1085,7 @@ public class BasicBoard implements java.io.Serializable
|
|||
|
||||
/**
|
||||
* Returns the list of items on the eu.mihosoft.freerouting.board, whose shape on layer p_layer contains the point at p_location.
|
||||
* If p_layer < 0, the layer is ignored.
|
||||
* If p_layer {@literal <} 0, the layer is ignored.
|
||||
* If p_item_selection_filter != null, only items of types selected by the filter are picked.
|
||||
*/
|
||||
public Set<Item> pick_items(Point p_location, int p_layer, ItemSelectionFilter p_filter)
|
||||
|
|
|
|||
|
|
@ -68,7 +68,7 @@ public interface Connectable
|
|||
/**
|
||||
* Returns all connectable items of the net with number p_net_no, which can be reached recursively
|
||||
* from this item via normal contacts.
|
||||
* if (p_net_no <= 0, the net number is ignored.
|
||||
* if (p_net_no {@literal <}= 0, the net number is ignored.
|
||||
*/
|
||||
Set<Item> get_connected_set(int p_net_no);
|
||||
|
||||
|
|
|
|||
|
|
@ -476,19 +476,19 @@ public abstract class DrillItem extends Item implements Connectable, java.io.Ser
|
|||
|
||||
/**
|
||||
* Contains the precalculated mininal width of the shapes of this DrillItem on all layers.
|
||||
* If < 0, the value is not yet calculated
|
||||
* If {@literal <} 0, the value is not yet calculated
|
||||
*/
|
||||
private double precalculated_min_width = -1;
|
||||
|
||||
/**
|
||||
* Contains the precalculated first layer, where this DrillItem contains a pad shape.
|
||||
* If < 0, the value is not yet calculated
|
||||
* If {@literal <} 0, the value is not yet calculated
|
||||
*/
|
||||
private int precalculated_first_layer = -1;
|
||||
|
||||
/**
|
||||
* Contains the precalculated last layer, where this DrillItem contains a pad shape.
|
||||
* If < 0, the value is not yet calculated
|
||||
* If {@literal <} 0, the value is not yet calculated
|
||||
*/
|
||||
private int precalculated_last_layer = -1;
|
||||
|
||||
|
|
|
|||
|
|
@ -212,7 +212,7 @@ public abstract class Item implements Drawable, SearchTreeObject, ObjectInfoPane
|
|||
|
||||
/**
|
||||
* Creates a copy of this item with id number p_id_no.
|
||||
* If p_id_no <= 0, the id_no of the new item is generated internally
|
||||
* If p_id_no {@literal <}= 0, the id_no of the new item is generated internally
|
||||
*/
|
||||
public abstract Item copy(int p_id_no);
|
||||
|
||||
|
|
@ -570,7 +570,7 @@ public abstract class Item implements Drawable, SearchTreeObject, ObjectInfoPane
|
|||
/**
|
||||
* Returns the set of all Connectable items of the net with number p_net_no which can be reached recursively
|
||||
* via normal contacts from this item.
|
||||
* If p_net_no <= 0, the net number is ignored.
|
||||
* If p_net_no {@literal <}= 0, the net number is ignored.
|
||||
*/
|
||||
public Set<Item> get_connected_set(int p_net_no)
|
||||
{
|
||||
|
|
@ -580,7 +580,7 @@ public abstract class Item implements Drawable, SearchTreeObject, ObjectInfoPane
|
|||
/**
|
||||
* Returns the set of all Connectable items of the net with number p_net_no which can be reached recursively
|
||||
* via normal contacts from this item.
|
||||
* If p_net_no <= 0, the net number is ignored.
|
||||
* If p_net_no {@literal <}= 0, the net number is ignored.
|
||||
* If p_stop_at_plane, the recursive algorithm stops, when a conduction area is reached,
|
||||
* which does not belong to a component.
|
||||
*/
|
||||
|
|
@ -673,7 +673,7 @@ public abstract class Item implements Drawable, SearchTreeObject, ObjectInfoPane
|
|||
/**
|
||||
* Returns the set of all Connectable items belonging to the net with number p_net_no,
|
||||
* which are not in the connected set of this item.
|
||||
* If p_net_no <= 0, the net numbers contained in this items are used instead of p_net_no.
|
||||
* If p_net_no {@literal <}= 0, the net numbers contained in this items are used instead of p_net_no.
|
||||
*/
|
||||
public Set<Item> get_unconnected_set(int p_net_no)
|
||||
{
|
||||
|
|
@ -876,7 +876,7 @@ public abstract class Item implements Drawable, SearchTreeObject, ObjectInfoPane
|
|||
|
||||
/**
|
||||
* Returns for this item the layer of the shape with index p_index.
|
||||
* If p_id_no <= 0, it w2ill be generated internally.
|
||||
* If p_id_no {@literal <}= 0, it w2ill be generated internally.
|
||||
*/
|
||||
public abstract int shape_layer(int p_index);
|
||||
|
||||
|
|
@ -1004,7 +1004,7 @@ public abstract class Item implements Drawable, SearchTreeObject, ObjectInfoPane
|
|||
}
|
||||
|
||||
/**
|
||||
* gets the p_no-th net number of this item for 0 <= p_no < this.net_count().
|
||||
* gets the p_no-th net number of this item for 0 {@literal <}= p_no {@literal <} this.net_count().
|
||||
*/
|
||||
public int get_net_no(int p_no)
|
||||
{
|
||||
|
|
@ -1103,7 +1103,7 @@ public abstract class Item implements Drawable, SearchTreeObject, ObjectInfoPane
|
|||
|
||||
/**
|
||||
* Makes this item connectable and assigns it to the input net.
|
||||
* If p_net_no < 0, the net items net number will be removed and the item will no longer be connectable.
|
||||
* If p_net_no {@literal <} 0, the net items net number will be removed and the item will no longer be connectable.
|
||||
*/
|
||||
public void assign_net_no(int p_net_no)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -577,7 +577,7 @@ public abstract class PullTightAlgo
|
|||
|
||||
abstract Polyline smoothen_end_corner_at_trace(PolylineTrace p_trace);
|
||||
protected final RoutingBoard board;
|
||||
/** If only_net_no > 0, only nets with this net numbers are optimized. */
|
||||
/** If only_net_no {@literal >} 0, only nets with this net numbers are optimized. */
|
||||
protected final int[] only_net_no_arr;
|
||||
protected int curr_layer;
|
||||
protected int curr_half_width;
|
||||
|
|
|
|||
|
|
@ -207,11 +207,11 @@ public class RoutingBoard extends BasicBoard implements java.io.Serializable
|
|||
|
||||
/**
|
||||
* Optimizes the route in the internally marked area.
|
||||
* If p_net_no > 0, only traces with net number p_net_no are optimized.
|
||||
* If p_net_no {@literal >} 0, only traces with net number p_net_no are optimized.
|
||||
* If p_clip_shape != null the optimizing is restricted to p_clip_shape.
|
||||
* p_trace_cost_arr is used for optimizing vias and may be null.
|
||||
* If p_stoppable_thread != null, the agorithm can be requested to be stopped.
|
||||
* If p_time_limit > 0; the algorithm will be stopped after p_time_limit Milliseconds.
|
||||
* If p_time_limit {@literal >} 0; the algorithm will be stopped after p_time_limit Milliseconds.
|
||||
*/
|
||||
public void opt_changed_area(int[] p_only_net_no_arr, IntOctagon p_clip_shape, int p_accuracy, ExpansionCostFactor[] p_trace_cost_arr,
|
||||
Stoppable p_stoppable_thread, int p_time_limit)
|
||||
|
|
@ -222,11 +222,11 @@ public class RoutingBoard extends BasicBoard implements java.io.Serializable
|
|||
|
||||
/**
|
||||
* Optimizes the route in the internally marked area.
|
||||
* If p_net_no > 0, only traces with net number p_net_no are optimized.
|
||||
* If p_net_no {@literal >} 0, only traces with net number p_net_no are optimized.
|
||||
* If p_clip_shape != null the optimizing is restricted to p_clip_shape.
|
||||
* p_trace_cost_arr is used for optimizing vias and may be null.
|
||||
* If p_stoppable_thread != null, the agorithm can be requested to be stopped.
|
||||
* If p_time_limit > 0; the algorithm will be stopped after p_time_limit Milliseconds.
|
||||
* If p_time_limit {@literal >} 0; the algorithm will be stopped after p_time_limit Milliseconds.
|
||||
* If p_keep_point != null, traces on layer p_keep_point_layer containing p_keep_point
|
||||
* will also contain this point after optimizing.
|
||||
*/
|
||||
|
|
@ -491,7 +491,7 @@ public class RoutingBoard extends BasicBoard implements java.io.Serializable
|
|||
* If p_from_item != null, items, which are connected to p_from_item, are
|
||||
* ignored.
|
||||
* Returns null, if no item is found,
|
||||
* If p_layer < 0, the layer is ignored
|
||||
* If p_layer {@literal <} 0, the layer is ignored
|
||||
*/
|
||||
public Item pick_nearest_routing_item(Point p_location, int p_layer, Item p_from_item)
|
||||
{
|
||||
|
|
@ -982,7 +982,7 @@ public class RoutingBoard extends BasicBoard implements java.io.Serializable
|
|||
|
||||
/**
|
||||
* Autoroutes from the input pin until the first via, in case the pin and its connected set
|
||||
* has only 1 layer. Ripup is allowed if p_ripup_costs is >= 0.
|
||||
* has only 1 layer. Ripup is allowed if p_ripup_costs is {@literal >}= 0.
|
||||
* Returns an enum of type AutorouteEngine.AutorouteResult
|
||||
*/
|
||||
public AutorouteEngine.AutorouteResult fanout(Pin p_pin, eu.mihosoft.freerouting.interactive.Settings p_settings, int p_ripup_costs,
|
||||
|
|
@ -1124,7 +1124,7 @@ public class RoutingBoard extends BasicBoard implements java.io.Serializable
|
|||
|
||||
/**
|
||||
* Removes all trace tails of the input net.
|
||||
* If p_net_no <= 0, the tails of all nets are removed.
|
||||
* If p_net_no {@literal <}= 0, the tails of all nets are removed.
|
||||
* Returns true, if something was removed.
|
||||
*/
|
||||
public boolean remove_trace_tails(int p_net_no, Item.StopConnectionOption p_stop_connection_option)
|
||||
|
|
|
|||
|
|
@ -347,7 +347,7 @@ public class ShapeSearchTree extends eu.mihosoft.freerouting.datastructures.MinA
|
|||
/**
|
||||
* Puts all items in the tree overlapping with p_shape
|
||||
* on layer p_layer into p_obstacles.
|
||||
* If p_layer < 0, the layer is ignored.
|
||||
* If p_layer {@literal <} 0, the layer is ignored.
|
||||
*/
|
||||
public void overlapping_objects(ConvexShape p_shape, int p_layer, int[] p_ignore_net_nos,
|
||||
Set<SearchTreeObject> p_obstacles)
|
||||
|
|
@ -367,7 +367,7 @@ public class ShapeSearchTree extends eu.mihosoft.freerouting.datastructures.MinA
|
|||
|
||||
/**
|
||||
* Returns all SearchTreeObjects on layer p_layer, which overlap with p_shape.
|
||||
* If p_layer < 0, the layer is ignored
|
||||
* If p_layer {@literal <} 0, the layer is ignored
|
||||
*/
|
||||
public Set<SearchTreeObject> overlapping_objects(ConvexShape p_shape, int p_layer)
|
||||
{
|
||||
|
|
@ -379,7 +379,7 @@ public class ShapeSearchTree extends eu.mihosoft.freerouting.datastructures.MinA
|
|||
/**
|
||||
* Puts all tree entries overlapping with p_shape
|
||||
* on layer p_layer into the list p_obstacles.
|
||||
* If p_layer < 0, the layer is ignored.
|
||||
* If p_layer {@literal <} 0, the layer is ignored.
|
||||
*/
|
||||
public void overlapping_tree_entries(ConvexShape p_shape, int p_layer, Collection<TreeEntry> p_tree_entries)
|
||||
{
|
||||
|
|
@ -389,7 +389,7 @@ public class ShapeSearchTree extends eu.mihosoft.freerouting.datastructures.MinA
|
|||
/**
|
||||
* Puts all tree entries overlapping with p_shape
|
||||
* on layer p_layer into the list p_obstacles.
|
||||
* If p_layer < 0, the layer is ignored.
|
||||
* If p_layer {@literal <} 0, the layer is ignored.
|
||||
* tree_entries with object containing a net number of p_ignore_net_nos are ignored.
|
||||
*/
|
||||
public void overlapping_tree_entries(ConvexShape p_shape, int p_layer, int[] p_ignore_net_nos,
|
||||
|
|
@ -553,7 +553,7 @@ public class ShapeSearchTree extends eu.mihosoft.freerouting.datastructures.MinA
|
|||
/**
|
||||
* Puts all items in the tree overlapping with p_shape
|
||||
* on layer p_layer into p_obstacles, if p_obstacles != null.
|
||||
* If p_layer < 0, the layer is ignored.
|
||||
* If p_layer {@literal <} 0, the layer is ignored.
|
||||
*/
|
||||
public void overlapping_objects_with_clearance(ConvexShape p_shape, int p_layer, int[] p_ignore_net_nos,
|
||||
int p_cl_type, Set<SearchTreeObject> p_obstacles)
|
||||
|
|
@ -585,7 +585,7 @@ public class ShapeSearchTree extends eu.mihosoft.freerouting.datastructures.MinA
|
|||
* which describes the required clearance restrictions to other items.
|
||||
* The function may also return items, which are nearly overlapping,
|
||||
* but do not overlap with exact calculation.
|
||||
* If p_layer < 0, the layer is ignored.
|
||||
* If p_layer {@literal <} 0, the layer is ignored.
|
||||
*/
|
||||
public Set<Item> overlapping_items_with_clearance(ConvexShape p_shape, int p_layer, int[] p_ignore_net_nos,
|
||||
int p_clearance_class)
|
||||
|
|
@ -610,7 +610,7 @@ public class ShapeSearchTree extends eu.mihosoft.freerouting.datastructures.MinA
|
|||
* inclusive clearance.
|
||||
* p_clearance_class is the index in the clearance matrix,
|
||||
* which describes the required clearance restrictions to other items.
|
||||
* If p_layer < 0, the layer is ignored.
|
||||
* If p_layer {@literal <} 0, the layer is ignored.
|
||||
*/
|
||||
public Collection<TreeEntry> overlapping_tree_entries_with_clearance(ConvexShape p_shape, int p_layer,
|
||||
int[] p_ignore_net_nos, int p_clearance_class)
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@
|
|||
package eu.mihosoft.freerouting.board;
|
||||
|
||||
/**
|
||||
* If > RELEASE, some features may be used, which are still in experimental state.
|
||||
* If {@literal >} RELEASE, some features may be used, which are still in experimental state.
|
||||
* Also warnings for debugging may be printed depending on the test_level.
|
||||
*
|
||||
* @author alfons
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@ public interface ConvexShape extends Shape
|
|||
|
||||
/**
|
||||
* Calculates the offset shape by p_distance.
|
||||
* If p_distance > 0, the shape will be enlarged, else the result
|
||||
* If p_distance {@literal >} 0, the shape will be enlarged, else the result
|
||||
* shape will be smaller.
|
||||
*/
|
||||
ConvexShape offset(double p_distance);
|
||||
|
|
|
|||
|
|
@ -179,8 +179,8 @@ public abstract class Direction implements Comparable<Direction>, java.io.Seria
|
|||
/**
|
||||
* The function returns
|
||||
* Signum.POSITIVE, if the scalar product of of a vector representing
|
||||
* this direction and a vector representing p_other is > 0,
|
||||
* Signum.NEGATIVE, if the scalar product is < 0,
|
||||
* this direction and a vector representing p_other is {@literal >} 0,
|
||||
* Signum.NEGATIVE, if the scalar product is {@literal <} 0,
|
||||
* and Signum.ZERO, if the scalar product is equal 0.
|
||||
*/
|
||||
public Signum projection(Direction p_other)
|
||||
|
|
|
|||
|
|
@ -63,7 +63,7 @@ public class Ellipse implements java.io.Serializable
|
|||
|
||||
public final FloatPoint center;
|
||||
|
||||
/** Rotation of the ellipse in radian normed to 0 <= rotation < pi */
|
||||
/** Rotation of the ellipse in radian normed to 0 {@literal <}= rotation {@literal <} pi */
|
||||
public final double rotation;
|
||||
public final double bigger_radius;
|
||||
public final double smaller_radius;
|
||||
|
|
|
|||
|
|
@ -90,7 +90,7 @@ public class FloatLine
|
|||
|
||||
/**
|
||||
* translates the line perpendicular at about p_dist.
|
||||
* If p_dist > 0, the line will be translated to the left, else to the right
|
||||
* If p_dist {@literal >} 0, the line will be translated to the left, else to the right
|
||||
*/
|
||||
public FloatLine translate(double p_dist)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -198,7 +198,7 @@ public class IntBox extends RegularTileShape implements java.io.Serializable
|
|||
/**
|
||||
* Calculates the sorted p_max_result_points nearest points on the border of this box.
|
||||
* p_point is assumed to be located in the interiour of this nox.
|
||||
* The funtion is only imoplemented for p_max_result_points <= 2;
|
||||
* The funtion is only imoplemented for p_max_result_points {@literal <}= 2;
|
||||
*/
|
||||
public IntPoint[] nearest_border_projections(IntPoint p_point, int p_max_result_points)
|
||||
{
|
||||
|
|
@ -530,7 +530,7 @@ public class IntBox extends RegularTileShape implements java.io.Serializable
|
|||
|
||||
/**
|
||||
* Returns the box offseted by p_dist.
|
||||
* If p_dist > 0, the offset is to the outside,
|
||||
* If p_dist {@literal >} 0, the offset is to the outside,
|
||||
* else to the inside.
|
||||
*/
|
||||
public IntBox offset(double p_dist)
|
||||
|
|
@ -547,7 +547,7 @@ public class IntBox extends RegularTileShape implements java.io.Serializable
|
|||
|
||||
/**
|
||||
* Returns the box, where the horizontal boundary is offseted by p_dist.
|
||||
* If p_dist > 0, the offset is to the outside,
|
||||
* If p_dist {@literal >} 0, the offset is to the outside,
|
||||
* else to the inside.
|
||||
*/
|
||||
public IntBox horizontal_offset(double p_dist)
|
||||
|
|
@ -564,7 +564,7 @@ public class IntBox extends RegularTileShape implements java.io.Serializable
|
|||
|
||||
/**
|
||||
* Returns the box, where the vertical boundary is offseted by p_dist.
|
||||
* If p_dist > 0, the offset is to the outside,
|
||||
* If p_dist {@literal >} 0, the offset is to the outside,
|
||||
* else to the inside.
|
||||
*/
|
||||
public IntBox vertical_offset(double p_dist)
|
||||
|
|
|
|||
|
|
@ -210,8 +210,8 @@ public class IntVector extends Vector implements java.io.Serializable
|
|||
|
||||
/**
|
||||
* The function returns
|
||||
* Signum.POSITIVE, if the scalar product of this vector and p_other > 0,
|
||||
* Signum.NEGATIVE, if the scalar product Vector is < 0,
|
||||
* Signum.POSITIVE, if the scalar product of this vector and p_other {@literal >} 0,
|
||||
* Signum.NEGATIVE, if the scalar product Vector is {@literal <} 0,
|
||||
* and Signum.ZERO, if the scalar product is equal 0.
|
||||
*/
|
||||
public Signum projection(Vector p_other)
|
||||
|
|
|
|||
|
|
@ -447,7 +447,7 @@ public class Line implements Comparable<Line>, java.io.Serializable
|
|||
|
||||
/**
|
||||
* translates the line perpendicular at about p_dist.
|
||||
* If p_dist > 0, the line will be translated to the left, else to the right
|
||||
* If p_dist {@literal >} 0, the line will be translated to the left, else to the right
|
||||
*/
|
||||
public Line translate(double p_dist)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -135,8 +135,8 @@ public class Polygon implements java.io.Serializable
|
|||
}
|
||||
/**
|
||||
* Returns the winding number of this polygon, treated as closed.
|
||||
* It will be > 0, if the corners are in countercock sense,
|
||||
* and < 0, if the corners are in clockwise sense.
|
||||
* It will be {@literal >} 0, if the corners are in countercock sense,
|
||||
* and {@literal <} 0, if the corners are in clockwise sense.
|
||||
*/
|
||||
public int winding_number_after_closing()
|
||||
{
|
||||
|
|
|
|||
|
|
@ -45,7 +45,7 @@ public class Polyline implements java.io.Serializable
|
|||
* creates a polyline of length p_polygon.corner_count + 1 from p_polygon,
|
||||
* so that the i-th corner of p_polygon will be the intersection of
|
||||
* the i-th and the i+1-th lines of the new created p_polyline
|
||||
* for 0 <= i < p_point_arr.length. p_polygon must have at least 2 corners
|
||||
* for 0 {@literal <}= i {@literal <} p_point_arr.length. p_polygon must have at least 2 corners
|
||||
*/
|
||||
public Polyline(Polygon p_polygon)
|
||||
{
|
||||
|
|
@ -597,7 +597,7 @@ public class Polyline implements java.io.Serializable
|
|||
/**
|
||||
* Calculates for the p_no-th line segment a shape around this line
|
||||
* where the right and left edge lines have the distance p_half_width
|
||||
* from the center line. 0 <= p_no <= arr.length - 3
|
||||
* from the center line. 0 {@literal <}= p_no {@literal <}= arr.length - 3
|
||||
*/
|
||||
public TileShape offset_shape(int p_half_width, int p_no)
|
||||
{
|
||||
|
|
@ -613,7 +613,7 @@ public class Polyline implements java.io.Serializable
|
|||
/**
|
||||
* Calculates for the p_no-th line segment a box shape around this line
|
||||
* where the border lines have the distance p_half_width
|
||||
* from the center line. 0 <= p_no <= arr.length - 3
|
||||
* from the center line. 0 {@literal <}= p_no {@literal <}= arr.length - 3
|
||||
*/
|
||||
public IntBox offset_box(int p_half_width, int p_no)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -147,8 +147,8 @@ public class RationalVector extends Vector implements java.io.Serializable
|
|||
|
||||
/**
|
||||
* The function returns
|
||||
* Signum.POSITIVE, if the scalar product of this vector and p_other > 0,
|
||||
* Signum.NEGATIVE, if the scalar product is < 0,
|
||||
* Signum.POSITIVE, if the scalar product of this vector and p_other {@literal >} 0,
|
||||
* Signum.NEGATIVE, if the scalar product is {@literal <} 0,
|
||||
* and Signum.ZERO, if the scalar product is equal 0.
|
||||
*/
|
||||
public Signum projection(Vector p_other)
|
||||
|
|
|
|||
|
|
@ -91,7 +91,7 @@ public class Simplex extends TileShape implements java.io.Serializable
|
|||
|
||||
/**
|
||||
* Returns true, if the determinant of the direction of index
|
||||
* p_no -1 and the direction of index p_no is > 0
|
||||
* p_no -1 and the direction of index p_no is {@literal >} 0
|
||||
*/
|
||||
public boolean corner_is_bounded(int p_no)
|
||||
{
|
||||
|
|
@ -684,7 +684,7 @@ public class Simplex extends TileShape implements java.io.Serializable
|
|||
|
||||
/**
|
||||
* Returns the simplex offseted by p_with.
|
||||
* If p_width > 0, the offset is to the outer, else to the inner.
|
||||
* If p_width {@literal >} 0, the offset is to the outer, else to the inner.
|
||||
*/
|
||||
public Simplex offset(double p_width)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -81,8 +81,8 @@ public abstract class Vector implements java.io.Serializable
|
|||
|
||||
/**
|
||||
* The function returns
|
||||
* Signum.POSITIVE, if the scalar product of this vector and p_other > 0,
|
||||
* Signum.NEGATIVE, if the scalar product Vector is < 0,
|
||||
* Signum.POSITIVE, if the scalar product of this vector and p_other {@literal >} 0,
|
||||
* Signum.NEGATIVE, if the scalar product Vector is {@literal <} 0,
|
||||
* and Signum.ZERO, if the scalar product is equal 0.
|
||||
*/
|
||||
public abstract Signum projection(Vector p_other);
|
||||
|
|
|
|||
|
|
@ -87,7 +87,7 @@ public class BoardFrame extends javax.swing.JFrame
|
|||
* files are allowed, so that the frame can be used in an applet.
|
||||
* Currently Option.EXTENDED_TOOL_BAR is used only if a new eu.mihosoft.freerouting.board is
|
||||
* created by the application from scratch.
|
||||
* If p_test_level > RELEASE_VERSION, functionality not yet ready for release is included.
|
||||
* If p_test_level {@literal >} RELEASE_VERSION, functionality not yet ready for release is included.
|
||||
* Also the warning output depends on p_test_level.
|
||||
*/
|
||||
public BoardFrame(DesignFile p_design, Option p_option, TestLevel p_test_level,
|
||||
|
|
|
|||
|
|
@ -376,7 +376,7 @@ public class BoardHandling extends BoardHandlingImpl
|
|||
|
||||
/**
|
||||
* Sets the manual trace half width used in eu.mihosoft.freerouting.interactive routing.
|
||||
* If p_layer_no < 0, the manual trace half width is changed on all layers.
|
||||
* If p_layer_no {@literal <} 0, the manual trace half width is changed on all layers.
|
||||
*/
|
||||
public void set_manual_trace_half_width(int p_layer_no, int p_value)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -144,8 +144,8 @@ public class RatsNest
|
|||
|
||||
/**
|
||||
* Returns the length of the violation of the length restriction of the net with number p_net_no,
|
||||
* > 0, if the cumulative trace length is to big,
|
||||
* < 0, if the trace length is to smalll,
|
||||
* {@literal >} 0, if the cumulative trace length is to big,
|
||||
* {@literal <} 0, if the trace length is to small,
|
||||
* 0, if the thace length is ok or the net has no length restrictions
|
||||
*/
|
||||
public double get_length_violation(int p_net_no)
|
||||
|
|
|
|||
|
|
@ -170,7 +170,7 @@ public class Settings implements java.io.Serializable
|
|||
}
|
||||
|
||||
/**
|
||||
* The horizontal placement grid when moving components, if > 0.
|
||||
* The horizontal placement grid when moving components, if {@literal >} 0.
|
||||
*/
|
||||
public int get_horizontal_component_grid()
|
||||
{
|
||||
|
|
@ -178,7 +178,7 @@ public class Settings implements java.io.Serializable
|
|||
}
|
||||
|
||||
/**
|
||||
* The vertical placement grid when moving components, if > 0.
|
||||
* The vertical placement grid when moving components, if {@literal >} 0.
|
||||
*/
|
||||
public int get_vertical_component_grid()
|
||||
{
|
||||
|
|
@ -238,7 +238,7 @@ public class Settings implements java.io.Serializable
|
|||
}
|
||||
|
||||
/**
|
||||
* The horizontal placement grid when moving components, if > 0.
|
||||
* The horizontal placement grid when moving components, if {@literal >} 0.
|
||||
*/
|
||||
public void set_horizontal_component_grid(int p_value)
|
||||
{
|
||||
|
|
@ -250,7 +250,7 @@ public class Settings implements java.io.Serializable
|
|||
}
|
||||
|
||||
/**
|
||||
* The vertical placement grid when moving components, if > 0.
|
||||
* The vertical placement grid when moving components, if {@literal >} 0.
|
||||
*/
|
||||
public void set_vertical_component_grid(int p_value)
|
||||
{
|
||||
|
|
@ -530,12 +530,12 @@ public class Settings implements java.io.Serializable
|
|||
boolean via_snap_to_smd_center;
|
||||
|
||||
/**
|
||||
* The horizontal placement grid when moving components, if > 0.
|
||||
* The horizontal placement grid when moving components, if {@literal >} 0.
|
||||
*/
|
||||
int horizontal_component_grid;
|
||||
|
||||
/**
|
||||
* The vertical placement grid when moving components, if > 0.
|
||||
* The vertical placement grid when moving components, if {@literal >} 0.
|
||||
*/
|
||||
int vertical_component_grid;
|
||||
|
||||
|
|
|
|||
|
|
@ -120,7 +120,7 @@ public class LogicalPart implements eu.mihosoft.freerouting.board.ObjectInfoPane
|
|||
|
||||
/**
|
||||
* The gate swap code. Gates with the same gate swap code can be swapped.
|
||||
* Gates with swap code <= 0 are not swappable.
|
||||
* Gates with swap code {@literal <}= 0 are not swappable.
|
||||
*/
|
||||
public final int gate_swap_code;
|
||||
|
||||
|
|
@ -129,7 +129,7 @@ public class LogicalPart implements eu.mihosoft.freerouting.board.ObjectInfoPane
|
|||
|
||||
/**
|
||||
* The pin swap code of the gate. Pins with the same pin swap code can be swapped inside a gate.
|
||||
* Pins with swap code <= 0 are not swappable.
|
||||
* Pins with swap code {@literal <}= 0 are not swappable.
|
||||
*/
|
||||
public final int gate_pin_swap_code;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -69,7 +69,7 @@ public class Padstacks implements java.io.Serializable
|
|||
}
|
||||
|
||||
/**
|
||||
* Returns the padstack with index p_padstack_no for 1 <= p_padstack_no <= padstack_count
|
||||
* Returns the padstack with index p_padstack_no for 1 {@literal <}= p_padstack_no {@literal <}= padstack_count
|
||||
*/
|
||||
public Padstack get(int p_padstack_no)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -58,7 +58,7 @@ public class BoardRules implements java.io.Serializable
|
|||
|
||||
/**
|
||||
* Returns true, if the trace widths used for routing for the input net are equal on all layers.
|
||||
* If p_net_no < 0, the default trace widths for all nets are checked.
|
||||
* If p_net_no {@literal <} 0, the default trace widths for all nets are checked.
|
||||
*/
|
||||
public boolean trace_widths_are_layer_dependent(int p_net_no)
|
||||
{
|
||||
|
|
@ -397,7 +397,7 @@ public class BoardRules implements java.io.Serializable
|
|||
/**
|
||||
* Returns the minimum distance between the pin border and the next corner
|
||||
* of a connected trace por a pin with connection restrictions.
|
||||
* If the result is <= 0, there are no exit restrictions.
|
||||
* If the result is {@literal <}= 0, there are no exit restrictions.
|
||||
*/
|
||||
public double get_pin_edge_to_turn_dist()
|
||||
{
|
||||
|
|
@ -407,7 +407,7 @@ public class BoardRules implements java.io.Serializable
|
|||
/**
|
||||
* Sets he minimum distance between the pin border and the next corner
|
||||
* of a connected trace por a pin with connection restrictions.
|
||||
* if p_value is <= 0, there are no exit restrictions.
|
||||
* if p_value is {@literal <}= 0, there are no exit restrictions.
|
||||
*/
|
||||
public void set_pin_edge_to_turn_dist(double p_value)
|
||||
{
|
||||
|
|
@ -542,7 +542,7 @@ public class BoardRules implements java.io.Serializable
|
|||
/**
|
||||
* The minimum distance of the pad border to the first turn of a connected trace
|
||||
* to a pin with restricted exit directions.
|
||||
* If the value is <= 0, there are no exit restrictions.
|
||||
* If the value is {@literal <}= 0, there are no exit restrictions.
|
||||
*/
|
||||
private double pin_edge_to_turn_dist;
|
||||
|
||||
|
|
|
|||
|
|
@ -91,7 +91,7 @@ public class ClearanceMatrix implements java.io.Serializable
|
|||
}
|
||||
|
||||
/**
|
||||
* Sets the value of all clearance classes with number >= 1
|
||||
* Sets the value of all clearance classes with number {@literal >}= 1
|
||||
* to p_value on all layers.
|
||||
*/
|
||||
public void set_default_value(int p_value)
|
||||
|
|
@ -103,7 +103,7 @@ public class ClearanceMatrix implements java.io.Serializable
|
|||
}
|
||||
|
||||
/**
|
||||
* Sets the value of all clearance classes with number >= 1
|
||||
* Sets the value of all clearance classes with number {@literal >}= 1
|
||||
* to p_value on p_layer.
|
||||
*/
|
||||
public void set_default_value(int p_layer, int p_value)
|
||||
|
|
|
|||
|
|
@ -193,7 +193,7 @@ public class NetClass implements java.io.Serializable, eu.mihosoft.freerouting.b
|
|||
|
||||
/**
|
||||
* Returns the minimum trace length of this net class.
|
||||
* If the result is <= 0, there is no minimal trace length restriction.
|
||||
* If the result is {@literal <}= 0, there is no minimal trace length restriction.
|
||||
*/
|
||||
public double get_minimum_trace_length()
|
||||
{
|
||||
|
|
@ -202,7 +202,7 @@ public class NetClass implements java.io.Serializable, eu.mihosoft.freerouting.b
|
|||
|
||||
/**
|
||||
* Sets the minimum trace length of this net class to p_value.
|
||||
* If p_value is <= 0, there is no minimal trace length restriction.
|
||||
* If p_value is {@literal <}= 0, there is no minimal trace length restriction.
|
||||
*/
|
||||
public void set_minimum_trace_length(double p_value)
|
||||
{
|
||||
|
|
@ -211,7 +211,7 @@ public class NetClass implements java.io.Serializable, eu.mihosoft.freerouting.b
|
|||
|
||||
/**
|
||||
* Returns the maximum trace length of this net class.
|
||||
* If the result is <= 0, there is no maximal trace length restriction.
|
||||
* If the result is {@literal <}= 0, there is no maximal trace length restriction.
|
||||
*/
|
||||
public double get_maximum_trace_length()
|
||||
{
|
||||
|
|
@ -220,7 +220,7 @@ public class NetClass implements java.io.Serializable, eu.mihosoft.freerouting.b
|
|||
|
||||
/**
|
||||
* Sets the maximum trace length of this net class to p_value.
|
||||
* If p_value is <= 0, there is no maximal trace length restriction.
|
||||
* If p_value is {@literal <}= 0, there is no maximal trace length restriction.
|
||||
*/
|
||||
public void set_maximum_trace_length(double p_value)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -126,7 +126,7 @@ public class NetClasses implements java.io.Serializable
|
|||
|
||||
/**
|
||||
* Looks, if the list contains a net class with trace half width[i] all equal to p_trace_half_width_arr[i]
|
||||
* for 0 <= i < layer_count, trace clearance class equal to p_trace_clearance_class
|
||||
* for 0 {@literal <}= i {@literal <} layer_count, trace clearance class equal to p_trace_clearance_class
|
||||
* and via rule equal to p_via_rule. Returns null, if no such net class was found.
|
||||
*/
|
||||
public NetClass find(int[] p_trace_half_width_arr, int p_trace_clearance_class, ViaRule p_via_rule)
|
||||
|
|
|
|||
Loading…
Reference in New Issue