Javadoc warnings fixed

(Some JNA docs also changed to standard comments)
2026-09-27 18:01:09 +00:00 · 2015-04-06 06:32:40 +02:00
parent 1115432370
commit a7e79a9570
20 changed files with 221 additions and 220 deletions
@@ -311,9 +311,9 @@ public class CommandLineArgumentParser {
    /**
     * Parses the console arguments
     *
-     * @param arguments
+     * @param arguments Arguments
     * @return paths to the file which should be opened or null
-     * @throws java.io.IOException
+     * @throws java.io.IOException On error
     */
    public static String[] parseArguments(String[] arguments) throws IOException {
        Level traceLevel = Level.WARNING;
@@ -62,7 +62,7 @@ public class FontPanel extends javax.swing.JPanel {
    /**
     * Creates new form FontPanel
     *
-     * @param mainPanel
+     * @param mainPanel Main panel
     */
    public FontPanel(MainPanel mainPanel) {
        this.mainPanel = mainPanel;
@@ -38,9 +38,9 @@ public class FontPreviewDialog extends AppDialog {
    /**
     * Creates new form FontPreviewDialog
     *
-     * @param parent
-     * @param font
-     * @param modal
+     * @param parent Parent frame
+     * @param font Font
+     * @param modal Will show as modal?
     */
    public FontPreviewDialog(java.awt.Frame parent, boolean modal, Font font) {
        super();
@@ -46,7 +46,7 @@ public class LicenseUpdater {
     * Script for updating license header in java files :-)
     *
     * @param dir Star directory (e.g. "src/")
-     * @param lgpl
+     * @param lgpl Is LGPL?
     */
    public static void updateLicenseInDir(File dir, boolean lgpl) {

@@ -38,7 +38,8 @@ public class LinkLabel extends JLabel {
    /**
     * Creates a new LinkLabel with the given text.
     *
-     * @param text
+     * @param text Text
+     * @param url URL
     */
    public LinkLabel(String text, String url) {
        super(text);
@@ -55,7 +56,7 @@ public class LinkLabel extends JLabel {
    /**
     * Sets the text of the label.
     *
-     * @param text
+     * @param text Text to show
     */
    @Override
    public void setText(String text) {
@@ -66,7 +67,7 @@ public class LinkLabel extends JLabel {
    /**
     * Returns the text set by the user.
     *
-     * @return
+     * @return Text
     */
    public String getNormalText() {
        return text;
@@ -75,7 +76,7 @@ public class LinkLabel extends JLabel {
    /**
     * Processes mouse events and responds to clicks.
     *
-     * @param evt
+     * @param evt Event
     */
    @Override
    protected void processMouseEvent(MouseEvent evt) {
@@ -1002,7 +1002,7 @@ public class Main {

    /**
     * @param args the command line arguments
-     * @throws IOException
+     * @throws IOException On error
     */
    public static void main(String[] args) throws IOException {

@@ -19,7 +19,7 @@ package com.jpexs.decompiler.flash.gui;
 /**
 *
 * @author JPEXS
- * @param <E>
+ * @param <E> Element to search
 */
 public interface SearchListener<E> {

@@ -31,7 +31,7 @@ import jsyntaxpane.actions.DocumentSearchData;
 /**
 *
 * @author JPEXS
- * @param <E>
+ * @param <E> Element to search
 */
 public class SearchPanel<E> extends JPanel implements ActionListener {

@@ -35,7 +35,7 @@ import javax.swing.JScrollPane;
 /**
 *
 * @author JPEXS
- * @param <E>
+ * @param <E> Element to search
 */
 public class SearchResultsDialog<E> extends AppDialog implements ActionListener {

@@ -54,7 +54,7 @@ public class MyMarkers {
    /**
     * Remove all the markers from an JEditorPane
     *
-     * @param editorPane
+     * @param editorPane Editor
     */
    public static void removeMarkers(JTextComponent editorPane) {
        removeMarkers(editorPane, null);
@@ -63,9 +63,9 @@ public class MyMarkers {
    /**
     * add highlights for the given Token on the given pane
     *
-     * @param pane
-     * @param token
-     * @param marker
+     * @param pane Editor
+     * @param token Token
+     * @param marker Marker
     */
    public static void markToken(JTextComponent pane, Token token, Highlighter.HighlightPainter marker) {
        markText(pane, token.start, token.end(), marker);
@@ -74,10 +74,10 @@ public class MyMarkers {
    /**
     * add highlights for the given region on the given pane
     *
-     * @param pane
-     * @param start
-     * @param end
-     * @param marker
+     * @param pane Editor
+     * @param start Start index
+     * @param end End index
+     * @param marker Marker
     */
    public static void markText(JTextComponent pane, int start, int end, Highlighter.HighlightPainter marker) {
        try {
@@ -46,7 +46,7 @@ public class SpringUtilities {
     * A debugging utility that prints to stdout the component's minimum,
     * preferred, and maximum sizes.
     *
-     * @param c
+     * @param c Component
     */
    public static void printSizes(Component c) {
        System.out.println("minimumSize = " + c.getMinimumSize());
@@ -60,7 +60,7 @@ public class SpringUtilities {
     * preferred width and height of the components. The parent is made just big
     * enough to fit them all.
     *
-     * @param parent
+     * @param parent Parent container
     * @param rows number of rows
     * @param cols number of columns
     * @param initialX x location to start the grid at
@@ -163,7 +163,7 @@ public class SpringUtilities {
     * similarly determined for each row. The parent is made just big enough to
     * fit them all.
     *
-     * @param parent
+     * @param parent parent container
     * @param rows number of rows
     * @param cols number of columns
     * @param initialX x location to start the grid at
@@ -220,7 +220,7 @@ public class ProxyFrame extends AppFrame implements ActionListener, CatchedListe
    /**
     * Constructor
     *
-     * @param mainFrame
+     * @param mainFrame Main frame
     */
    public ProxyFrame(final MainFrame mainFrame) {

@@ -66,7 +66,7 @@ public class SWFListModel implements ListModel<Replacement> {
    /**
     * Called when data in a replacement changed
     *
-     * @param index
+     * @param index Index of which SWF changed
     */
    public void dataChanged(int index) {
        if (index == -1) {