Mercurial > hg > release > icedtea-web-1.7
changeset 1509:fcb841380712
Fixed few javadoc issues.
line wrap: on
line diff
--- a/netx/net/sourceforge/jnlp/security/appletextendedsecurity/UnsignedAppletActionStorage.java Tue Dec 18 11:21:44 2018 +0100 +++ b/netx/net/sourceforge/jnlp/security/appletextendedsecurity/UnsignedAppletActionStorage.java Tue Dec 18 11:22:16 2018 +0100 @@ -54,8 +54,8 @@ /** * This methods iterates through records in - * {@link net.sourceforge.jnlp.config.DeploymentConfiguration#getAppletTrustUserSettingsPath} or - * {@link net.sourceforge.jnlp.config.DeploymentConfiguration#getAppletTrustGlobalSettingsPath}, and is matching + * net.sourceforge.jnlp.config.DeploymentConfiguration#getAppletTrustUserSettingsPath or + * net.sourceforge.jnlp.config.DeploymentConfiguration#getAppletTrustGlobalSettingsPath, and is matching * regexes saved here against params. So parameters here are NOT regexes, * but are matched against saved regexes. * <p> @@ -103,12 +103,12 @@ /** * Will add new record. Note that regexes are stored for bases matching. * <p> - * eg {@link UnsignedAppletActionEntry} which will deny some applet no matter of - * page will be {@code new }{@link UnsignedAppletActionEntry#UnsignedAppletActionEntry UnsignedAppletActionEntry}{@code (}{@link ExecuteUnsignedApplet#NEVER}{@code , new }{@link java.util.Date#Date() Date()}{@code , null, null, someMain, someArchives)} + * eg UnsignedAppletActionEntry which will deny some applet no matter of + * page will be {@code new }{@link UnsignedAppletActionEntry#UnsignedAppletActionEntry UnsignedAppletActionEntry}{@code (} ExecuteUnsignedApplet#NEVER{@code , new }{@link java.util.Date#Date() Date()}{@code , null, null, someMain, someArchives)} * </p> * <p> * eg {@link UnsignedAppletActionEntry} which will - * allow all applets on page with same codebase will be {@code new }{@link UnsignedAppletActionEntry#UnsignedAppletActionEntry UnsignedAppletActionEntry}{@code (}{@link ExecuteUnsignedApplet#NEVER}{@code , new }{@link java.util.Date#Date() Date()}{@code , ".*", ".*", null, null);} + * allow all applets on page with same codebase will be {@code new }{@link UnsignedAppletActionEntry#UnsignedAppletActionEntry UnsignedAppletActionEntry}{@code (} ExecuteUnsignedApplet#NEVER {@code , new }{@link java.util.Date#Date() Date()}{@code , ".*", ".*", null, null);} * </p> * @param item */
--- a/netx/net/sourceforge/jnlp/security/dialogs/ViwableDialog.java Tue Dec 18 11:21:44 2018 +0100 +++ b/netx/net/sourceforge/jnlp/security/dialogs/ViwableDialog.java Tue Dec 18 11:22:16 2018 +0100 @@ -147,7 +147,7 @@ /** * Adds an {@link ActionListener} which will be notified if the user makes a * choice using this SecurityDialog. The listener should use - * {@link #getValue()} to actually get the user's response. + * getValue() to actually get the user's response. * * @param listener another action listener to be listen to */
--- a/netx/net/sourceforge/jnlp/splashscreen/parts/InformationElement.java Tue Dec 18 11:21:44 2018 +0100 +++ b/netx/net/sourceforge/jnlp/splashscreen/parts/InformationElement.java Tue Dec 18 11:22:16 2018 +0100 @@ -48,7 +48,7 @@ import net.sourceforge.jnlp.util.logging.OutputController; /** - * This class is wrapper arround <information> tag which should + * This class is wrapper arround the *information* tag element which should * javaws provide from source jnlp file */ public class InformationElement {
--- a/netx/net/sourceforge/jnlp/util/lockingfile/LockedFile.java Tue Dec 18 11:21:44 2018 +0100 +++ b/netx/net/sourceforge/jnlp/util/lockingfile/LockedFile.java Tue Dec 18 11:22:16 2018 +0100 @@ -116,7 +116,8 @@ } /** - * Lock access to the file. Lock is reentrant. + * Lock access to the file.Lock is reentrant. + * @throws java.io.IOException */ public void lock() throws IOException { // Create if does not already exist, cannot lock non-existing file @@ -153,7 +154,8 @@ } /** - * Unlock access to the file. Lock is reentrant. Does not do anything if not holding the lock. + * Unlock access to the file.Lock is reentrant. Does not do anything if not holding the lock. + * @throws java.io.IOException */ public void unlock() throws IOException { if (!this.threadLock.isHeldByCurrentThread()) {
--- a/netx/net/sourceforge/jnlp/util/lockingfile/LockingReaderWriter.java Tue Dec 18 11:21:44 2018 +0100 +++ b/netx/net/sourceforge/jnlp/util/lockingfile/LockingReaderWriter.java Tue Dec 18 11:22:16 2018 +0100 @@ -64,7 +64,7 @@ /** * Get the underlying file. - * Any access to this file should use lock() & unlock(). + * Any access to this file should use lock() and unlock(). * * @return the file */
--- a/netx/net/sourceforge/jnlp/util/replacements/CharacterDecoder.java Tue Dec 18 11:21:44 2018 +0100 +++ b/netx/net/sourceforge/jnlp/util/replacements/CharacterDecoder.java Tue Dec 18 11:22:16 2018 +0100 @@ -38,7 +38,6 @@ * A character decoder is an algorithim for transforming 8 bit * binary data that has been encoded into text by a character * encoder, back into original binary form. - * <p> * The character encoders, in general, have been structured * around a central theme that binary data can be encoded into * text that has the form: @@ -47,7 +46,6 @@ * [Line Prefix][encoded data atoms][Line Suffix] * [Buffer Suffix] * </code></pre> - * </p> * <p> * Of course in the simplest encoding schemes, the buffer has no * distinct prefix of suffix, however all have some fixed relationship @@ -64,11 +62,11 @@ * abstract methods in this class. * </p> * <dl> - * <dd/>bytesPerAtom which tells the decoder how many bytes to - * expect from decodeAtom - * <dd/>decodeAtom which decodes the bytes sent to it as text. - * <dd/>bytesPerLine which tells the encoder the maximum number of - * bytes per line. + * <dd>bytesPerAtom which tells the decoder how many bytes to + * expect from decodeAtom</dd> + * <dd>decodeAtom which decodes the bytes sent to it as text.</dd> + * <dd>bytesPerLine which tells the encoder the maximum number of + * bytes per line.</dd> * </dl> * <p> * In general, the character decoders return error in the form of a @@ -123,7 +121,7 @@ /** * This method does an actual decode. It takes the decoded bytes and * writes them to the OutputStream. The integer <i>l</i> tells the - * method how many bytes are required. This is always <= bytesPerAtom(). + * method how many bytes are required. This is always less or equal to bytesPerAtom(). */ protected void decodeAtom(PushbackInputStream aStream, OutputStream bStream, int l) throws IOException { throw new CEStreamExhausted(); @@ -149,8 +147,7 @@ * Decode the text from the InputStream and write the decoded * octets to the OutputStream. This method runs until the stream * is exhausted. - * @exception CEFormatException An error has occured while decoding - * @exception CEStreamExhausted The input stream is unexpectedly out of data + * @exception IOException The input stream is unexpectedly out of data, An error has occured while decoding */ public void decodeBuffer(InputStream aStream, OutputStream bStream) throws IOException { int i; @@ -185,7 +182,7 @@ /** * Alternate decode interface that takes a String containing the encoded * buffer and returns a byte array containing the data. - * @exception CEFormatException An error has occured while decoding + * @exception IOException An error has occured while decoding */ public byte decodeBuffer(String inputString)[] throws IOException { byte inputBuffer[] = new byte[inputString.length()];
--- a/netx/net/sourceforge/jnlp/util/replacements/CharacterEncoder.java Tue Dec 18 11:21:44 2018 +0100 +++ b/netx/net/sourceforge/jnlp/util/replacements/CharacterEncoder.java Tue Dec 18 11:22:16 2018 +0100 @@ -39,7 +39,7 @@ * A character encoder is an algorithim for transforming 8 bit binary * data into text (generally 7 bit ASCII or 8 bit ISO-Latin-1 text) * for transmition over text channels such as e-mail and network news. - * <p> + * The character encoders have been structured around a central theme * that, in general, the encoded text has the form: * <pre><code> @@ -47,25 +47,22 @@ * [Line Prefix][encoded data atoms][Line Suffix] * [Buffer Suffix] * </code></pre> - * </p> - * <p> + * <p> * In the {@code CharacterEncoder} and {@link CharacterDecoder} * classes, one complete chunk of data is referred to as a * <i>buffer</i>. Encoded buffers are all text, and decoded buffers * (sometimes just referred to as buffers) are binary octets. * </p> - * <p> - * To create a custom encoder, you must, at a minimum, overide three + * To create a custom encoder, you must, at a minimum, overide three * abstract methods in this class. * <dl> - * <dd/>bytesPerAtom which tells the encoder how many bytes to - * send to encodeAtom - * <dd/>encodeAtom which encodes the bytes sent to it as text. - * <dd/>bytesPerLine which tells the encoder the maximum number of - * bytes per line. + * <dd>bytesPerAtom which tells the encoder how many bytes to + * send to encodeAtom</dd> + * <dd>encodeAtom which encodes the bytes sent to it as text.</dd> + * <dd>bytesPerLine which tells the encoder the maximum number of + * bytes per line.</dd> * </dl> - * </p> - * <p> + * <p> * Several useful encoders have already been written and are * referenced in the See Also list below. * </p> @@ -107,7 +104,7 @@ /** * Encode the suffix that ends every output line. By default - * this method just prints a <newline> into the output stream. + * this method just prints a newline into the output stream. */ protected void encodeLineSuffix(OutputStream aStream) throws IOException { pStream.println();
--- a/netx/net/sourceforge/jnlp/util/ui/package-info.java Tue Dec 18 11:21:44 2018 +0100 +++ b/netx/net/sourceforge/jnlp/util/ui/package-info.java Tue Dec 18 11:22:16 2018 +0100 @@ -34,7 +34,7 @@ * Contains classes that deal with common and recurring UI tasks. * <p> * <b>NOTE:</b> Before adding new self-sufficient {@code public static} methods - * to this package please evaluate thier suitability for {@link UI} first.</p> + * to this package please evaluate thier suitability for @link UI first.</p> * @since IcedTea-Web 1.5 */ package net.sourceforge.jnlp.util.ui;
--- a/netx/net/sourceforge/swing/ThreadCheckingRepaintManager.java Tue Dec 18 11:21:44 2018 +0100 +++ b/netx/net/sourceforge/swing/ThreadCheckingRepaintManager.java Tue Dec 18 11:22:16 2018 +0100 @@ -46,7 +46,7 @@ /** * Initially there was a rule that it is safe to create and use Swing components until they are realized but this * rule is not valid any more, and now it is recommended to interact with Swing from EDT only. - * <p/> + * * That's why completeCheck flag is used - if you test the old program switch it to false, but new applications * should be tested with completeCheck set to true* *
--- a/tests/junit-runner/JunitLikeXmlOutputListener.java Tue Dec 18 11:21:44 2018 +0100 +++ b/tests/junit-runner/JunitLikeXmlOutputListener.java Tue Dec 18 11:22:16 2018 +0100 @@ -389,7 +389,7 @@ * * You just put eg @Bug(id="RH12345",id="http:/my.bukpage.com/terribleNew") * and RH12345 will be transalated as - * <a href="https://bugzilla.redhat.com/show_bug.cgi?id=123456">123456<a> or + * <a href="https://bugzilla.redhat.com/show_bug.cgi?id=123456">123456</a> or * similar, the url will be inclueded as is. Both added to proper tests or suites * * @return Strng[2]{nameToBeShown, hrefValue}
--- a/tests/test-extensions/net/sourceforge/jnlp/annotations/Bug.java Tue Dec 18 11:21:44 2018 +0100 +++ b/tests/test-extensions/net/sourceforge/jnlp/annotations/Bug.java Tue Dec 18 11:22:16 2018 +0100 @@ -58,7 +58,7 @@ * and http://mail.openjdk.java.net/pipermail/ are proceed differently * You just put eg @Bug(id="RH12345",id="http:/my.bukpage.com/terribleNew") * and RH12345 will be transalated as - * <a href="https://bugzilla.redhat.com/show_bug.cgi?id=123456">123456<a> or + * <a href="https://bugzilla.redhat.com/show_bug.cgi?id=123456">123456</a> or * similar, the url will be inclueded as is. Both added to proper tests or suites * */
--- a/tests/test-extensions/net/sourceforge/jnlp/awt/AWTHelper.java Tue Dec 18 11:21:44 2018 +0100 +++ b/tests/test-extensions/net/sourceforge/jnlp/awt/AWTHelper.java Tue Dec 18 11:22:16 2018 +0100 @@ -337,8 +337,8 @@ * 4. sets screenCapture indicator to true (after tryKTimes unsuccessfull * tries an exception "ComponentNotFound" will be raised) * - * @throws AWTException - * @throws ComponentNotFoundException + * @throws ComponentNotFoundException + * @throws AWTFrameworkException * @throws AWTFrameworkException */ public void captureScreenAndFindAppletByIcon() throws ComponentNotFoundException, AWTFrameworkException {
--- a/tests/test-extensions/net/sourceforge/jnlp/awt/imagesearch/ComponentFinder.java Tue Dec 18 11:21:44 2018 +0100 +++ b/tests/test-extensions/net/sourceforge/jnlp/awt/imagesearch/ComponentFinder.java Tue Dec 18 11:22:16 2018 +0100 @@ -104,8 +104,8 @@ * * @param icon * @param iconPosition - * @param appletWidth - * @param appletHeight + * @param windowWidth + * @param windowHeight * @param screenshot * @return Rectangle rectangle where the applet resides */
--- a/tests/test-extensions/net/sourceforge/jnlp/tools/MessageProperties.java Tue Dec 18 11:21:44 2018 +0100 +++ b/tests/test-extensions/net/sourceforge/jnlp/tools/MessageProperties.java Tue Dec 18 11:22:16 2018 +0100 @@ -71,7 +71,8 @@ * @param locale the localization of Messages.properties to search * @param key * @return the message corresponding to the given key from the specified localization - * @throws IOException if the specified Messages localization is unavailable + * + * can throw wrapped IOException if the specified Messages localization is unavailable */ public static String getMessage(Locale locale, String key) { ResourceBundle bundle = PropertyResourceBundle.getBundle(resourcePath, locale);
--- a/tests/test-extensions/sun/applet/mock/PluginPipeMock.java Tue Dec 18 11:21:44 2018 +0100 +++ b/tests/test-extensions/sun/applet/mock/PluginPipeMock.java Tue Dec 18 11:22:16 2018 +0100 @@ -8,7 +8,7 @@ import java.util.concurrent.LinkedBlockingQueue; /** - * Helper for getting an input & output stream for use with PluginStreamHandler. + * Helper for getting an input and output stream for use with PluginStreamHandler. * Provides a convenient way of reading the Java requests and sending mocked * plugin responses. *