From: <ez...@us...> - 2007-02-05 23:12:07
|
Revision: 8898 http://svn.sourceforge.net/jedit/?rev=8898&view=rev Author: ezust Date: 2007-02-05 15:12:04 -0800 (Mon, 05 Feb 2007) Log Message: ----------- Updated javadocs and fixed some of the bad @links. Modified Paths: -------------- jEdit/trunk/org/gjt/sp/jedit/MiscUtilities.java jEdit/trunk/org/gjt/sp/jedit/gui/ExtendedGridLayout.java jEdit/trunk/org/gjt/sp/jedit/gui/ExtendedGridLayoutConstraints.java jEdit/trunk/org/gjt/sp/util/StandardUtilities.java Modified: jEdit/trunk/org/gjt/sp/jedit/MiscUtilities.java =================================================================== --- jEdit/trunk/org/gjt/sp/jedit/MiscUtilities.java 2007-02-05 21:34:48 UTC (rev 8897) +++ jEdit/trunk/org/gjt/sp/jedit/MiscUtilities.java 2007-02-05 23:12:04 UTC (rev 8898) @@ -98,7 +98,7 @@ //{{{ canonPath() method /** - * Returns the canonical form of the specified path name. Currently + * @return the canonical form of the specified path name. Currently * only expands a leading <code>~</code>. <b>For local path names * only.</b> * @param path The path name @@ -1002,7 +1002,7 @@ * Returns the number of leading white space characters in the * specified string. * @param str The string - * @deprecated use {@link StandardUtilities#getLeadingWhiteSpace(String)} + * @deprecated use {@link org.gjt.sp.util.StandardUtilities#getLeadingWhiteSpace(String)} */ @Deprecated public static int getLeadingWhiteSpace(String str) @@ -1016,7 +1016,7 @@ * specified string. * @param str The string * @since jEdit 2.5pre5 - * @deprecated use {@link StandardUtilities#getTrailingWhiteSpace(String)} + * @deprecated use {@link org.gjt.sp.util.StandardUtilities#getTrailingWhiteSpace(String)} */ @Deprecated public static int getTrailingWhiteSpace(String str) @@ -1030,7 +1030,7 @@ * string. * @param str The string * @param tabSize The tab size - * @deprecated use {@link StandardUtilities#getLeadingWhiteSpace(String)} + * @deprecated use {@link org.gjt.sp.util.StandardUtilities#getLeadingWhiteSpace(String)} */ @Deprecated public static int getLeadingWhiteSpaceWidth(String str, int tabSize) @@ -1046,7 +1046,7 @@ * @param seg The segment * @param tabSize The tab size * @since jEdit 4.1pre1 - * @deprecated use {@link StandardUtilities#getVirtualWidth(javax.swing.text.Segment, int)} + * @deprecated use {@link org.gjt.sp.util.StandardUtilities#getVirtualWidth(javax.swing.text.Segment, int)} */ @Deprecated public static int getVirtualWidth(Segment seg, int tabSize) @@ -1069,7 +1069,7 @@ * @return -1 if the column is out of bounds * * @since jEdit 4.1pre1 - * @deprecated use {@link StandardUtilities#getVirtualWidth(javax.swing.text.Segment, int)} + * @deprecated use {@link org.gjt.sp.util.StandardUtilities#getVirtualWidth(javax.swing.text.Segment, int)} */ @Deprecated public static int getOffsetOfVirtualColumn(Segment seg, int tabSize, @@ -1091,7 +1091,7 @@ * * @param len The length * @param tabSize The tab size, or 0 if tabs are not to be used - * @deprecated use {@link StandardUtilities#createWhiteSpace(int, int)} + * @deprecated use {@link org.gjt.sp.util.StandardUtilities#createWhiteSpace(int, int)} */ @Deprecated public static String createWhiteSpace(int len, int tabSize) @@ -1114,7 +1114,7 @@ * @param tabSize The tab size, or 0 if tabs are not to be used * @param start The start offset, for tab alignment * @since jEdit 4.2pre1 - * @deprecated use {@link StandardUtilities#createWhiteSpace(int, int, int)} + * @deprecated use {@link org.gjt.sp.util.StandardUtilities#createWhiteSpace(int, int, int)} */ @Deprecated public static String createWhiteSpace(int len, int tabSize, int start) @@ -1128,7 +1128,7 @@ * * ? becomes ., * becomes .*, {aa,bb} becomes (aa|bb). * @param glob The glob pattern - * @deprecated Use {@link StandardUtilities#globToRE(String)}. + * @deprecated Use {@link org.gjt.sp.util.StandardUtilities#globToRE(String)}. */ @Deprecated public static String globToRE(String glob) @@ -1245,7 +1245,7 @@ * @return negative If str1 < str2, 0 if both are the same, * positive if str1 > str2 * @since jEdit 4.0pre1 - * @deprecated use {@link StandardUtilities#compareStrings(String, String, boolean)} + * @deprecated use {@link org.gjt.sp.util.StandardUtilities#compareStrings(String, String, boolean)} */ @Deprecated public static int compareStrings(String str1, String str2, boolean ignoreCase) @@ -1260,7 +1260,7 @@ @Deprecated public static boolean stringsEqual(String s1, String s2) { - return StandardUtilities.objectsEqual(s1,s2); + return org.gjt.sp.util.StandardUtilities.objectsEqual(s1,s2); } //}}} //{{{ objectsEqual() method @@ -1477,7 +1477,7 @@ //{{{ StringCompare class /** * Compares strings. - * @deprecated use {@link org.gjt.sp.jedit.StandardUtilities.StringCompare} + * @deprecated use {@link org.gjt.sp.jedit.util.StandardUtilities#StringCompare} */ @Deprecated public static class StringCompare implements Compare Modified: jEdit/trunk/org/gjt/sp/jedit/gui/ExtendedGridLayout.java =================================================================== --- jEdit/trunk/org/gjt/sp/jedit/gui/ExtendedGridLayout.java 2007-02-05 21:34:48 UTC (rev 8897) +++ jEdit/trunk/org/gjt/sp/jedit/gui/ExtendedGridLayout.java 2007-02-05 23:12:04 UTC (rev 8898) @@ -33,21 +33,19 @@ import static org.gjt.sp.jedit.gui.ExtendedGridLayoutConstraints.REMAINDER; -/** - * The {@code ExtendedGridLayout} class is a layout manager - * that lays out a container's components in a rectangular grid - * with variable cell sizes that supports colspans and rowspans. +/** A layout manager that places components in a rectangular grid + * with variable cell sizes to support colspans and rowspans. * <p> - * The container is divided into rectangles, and one component is placed + * The container is divided into rectangles, and each component is placed * in a rectangular space defined by its colspan and rowspan. * Each row is as large as the largest component in * that row, and each column is as wide as the widest component in - * that column. + * that column. </p> * <p> - * This behavior is basically the same as in + * This behavior is similar to * <a href="http://java.sun.com/j2se/1.5.0/docs/api/java/awt/GridLayout.html">{@code java.awt.GridLayout}</a> - * but with different row heights and - * column widths for each row/column. + * but it supports different row heights and + * column widths for each row/column. </p> * <p> * For example, the following is a Dialog that lays out ten buttons * exactly the same as in the example of the JavaDoc of @@ -106,23 +104,23 @@ * moved rightside. If a rowspan hits a colspan, the colspan ends and the * rowspan takes precedence. * <p> - * Components for which {@code isVisible() == false} are ignored. With this, - * components can be replaced in the grid at runtime if you add a component - * that is visible and next to it a component that is invisible. If you then - * make the visible component invisible and the invisible one visible, the - * component gets replaced. + * Components for which {@code isVisible() == false} are ignored. Because + * of this, components can be replaced "in-place" by adding two components next to + * each other, with different <tt>isVisible()</tt> values, and toggling the + * <tt>setVisible()</tt> values of both when we wish to swap the currently + * visible component with the one that is hidden. </p> + * * <p> - * If you want to preserve free space without any component in the grid, - * use a <a href="http://java.sun.com/j2se/1.5.0/docs/api/javax/swing/Box.Filler.html">{@code javax.swing.Box.Filler}</a> - * as component if the free space is within a row, or just don't add components - * if the free space should be at the end of a row. + * If you want to reserve free space in a row inbetween components, + * add a <a href="http://java.sun.com/j2se/1.5.0/docs/api/javax/swing/Box.Filler.html">{@code javax.swing.Box.Filler}</a> + * to the layout. </p> * <p> - * If a row is higher, or a column is wider than the maximumSize of a component + * If a row is taller, or a column is wider than the <tt>maximumSize</tt> of a component, * the component is resized to its maximum size and aligned according to its - * alignmentX and alignmentY values. + * <tt>alignmentX</tt> and <tt>alignmentY</tt> values. </p> * <p> * One instance of this class can be used to layout multiple - * containers at the same time. + * containers at the same time. </p> * * @author Bj\xF6rn "Vampire" Kautler * @version 1.0 Modified: jEdit/trunk/org/gjt/sp/jedit/gui/ExtendedGridLayoutConstraints.java =================================================================== --- jEdit/trunk/org/gjt/sp/jedit/gui/ExtendedGridLayoutConstraints.java 2007-02-05 21:34:48 UTC (rev 8897) +++ jEdit/trunk/org/gjt/sp/jedit/gui/ExtendedGridLayoutConstraints.java 2007-02-05 23:12:04 UTC (rev 8898) @@ -18,8 +18,7 @@ import java.awt.Component; /** - * The {@code ExtendedGridLayoutConstraints} - * class specifies constraints for components + * Specifies constraints for components * that are laid out using the {@code ExtendedGridLayout} class. * * @version 1.0 Modified: jEdit/trunk/org/gjt/sp/util/StandardUtilities.java =================================================================== --- jEdit/trunk/org/gjt/sp/util/StandardUtilities.java 2007-02-05 21:34:48 UTC (rev 8897) +++ jEdit/trunk/org/gjt/sp/util/StandardUtilities.java 2007-02-05 23:12:04 UTC (rev 8898) @@ -341,7 +341,7 @@ //{{{ StringCompare class /** - * Compares strings. + * Compares objects as strings. */ public static class StringCompare implements Comparator { This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |