Fix javadoc.

2026-06-18 02:21:58 +00:00 · 2025-06-10 20:31:12 +02:00
parent 07108f5d2c
commit 17250e8d68
40 changed files with 58 additions and 42 deletions
--- a/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/ParseException.java
+++ b/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/ParseException.java
@@ -56,6 +56,7 @@ public abstract class ParseException extends Exception {
     *
     * @param text Text of the exception
     * @param line Line number where the exception occurred
+     * @param position Position in source text
     */
    public ParseException(String text, long line, long position) {
        super(text + (line == -1 ? "" : " on line " + line));
--- a/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/ZippedBundle.java
+++ b/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/ZippedBundle.java
@@ -63,7 +63,6 @@ public class ZippedBundle implements Bundle {
    /**
     * Initializes the bundle.
     *
-     * @param is Input stream
     * @param filename File
     * @throws IOException On I/O error
     */
--- a/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/abc/avm2/graph/AVM2GraphTargetDialect.java
+++ b/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/abc/avm2/graph/AVM2GraphTargetDialect.java
@@ -36,7 +36,7 @@ import java.util.ArrayList;
 import java.util.List;

 /**
- *
+ * AVM2 dialect.
 * @author JPEXS
 */
 public class AVM2GraphTargetDialect extends GraphTargetDialect {
--- a/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/abc/avm2/model/NullCoalesceAVM2Item.java
+++ b/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/abc/avm2/model/NullCoalesceAVM2Item.java
@@ -28,7 +28,7 @@ import java.util.ArrayList;
 import java.util.List;

 /**
- *
+ * Null coalesce operator (a ?? b).
 * @author JPEXS
 */
 public class NullCoalesceAVM2Item extends BinaryOpItem {
--- a/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/abc/avm2/model/PackageAVM2Item.java
+++ b/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/abc/avm2/model/PackageAVM2Item.java
@@ -25,7 +25,7 @@ import com.jpexs.decompiler.graph.model.LocalData;
 import java.util.List;

 /**
- *
+ * Package.
 * @author JPEXS
 */
 public class PackageAVM2Item extends AVM2Item {
--- a/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/abc/avm2/model/TraitSlotConstAVM2Item.java
+++ b/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/abc/avm2/model/TraitSlotConstAVM2Item.java
@@ -27,7 +27,7 @@ import com.jpexs.decompiler.graph.GraphTargetItem;
 import com.jpexs.decompiler.graph.model.LocalData;

 /**
- *
+ * Trait slot/const.
 * @author JPEXS
 */
 public class TraitSlotConstAVM2Item extends AVM2Item {
--- a/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/abc/avm2/parser/script/AbcIndexing.java
+++ b/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/abc/avm2/parser/script/AbcIndexing.java
@@ -650,6 +650,7 @@ public final class AbcIndexing {
     * @param findProtected Find protected namespace properties
     * @param type Property type
     * @param callType Call type
+     * @param foundStatic Trait found as static
     */
    public void findPropertyTypeOrCallType(ABC abc, GraphTargetItem cls, String propName, int ns, boolean findStatic, boolean findInstance, boolean findProtected, Reference<GraphTargetItem> type, Reference<GraphTargetItem> callType, Reference<Boolean> foundStatic) {
        TraitIndex traitIndex = findProperty(new PropertyDef(propName, cls, abc, ns), findStatic, findInstance, findProtected, foundStatic);
@@ -671,7 +672,8 @@ public final class AbcIndexing {
     * @param findStatic Find static properties
     * @param findInstance Find instance properties
     * @param findProtected Find protected namespace properties
-     * @return Trait index or null
+     * @param foundStatic Trait found as static
+     * @return Trait index or null     
     */
    public GraphTargetItem findPropertyType(ABC abc, GraphTargetItem cls, String propName, int ns, boolean findStatic, boolean findInstance, boolean findProtected, Reference<Boolean> foundStatic) {
        TraitIndex traitIndex = findProperty(new PropertyDef(propName, cls, abc, ns), findStatic, findInstance, findProtected, foundStatic);
@@ -690,6 +692,7 @@ public final class AbcIndexing {
     * @param findStatic Find static properties
     * @param findInstance Find instance properties
     * @param findProtected Find protected namespace properties
+     * @param foundStatic Trait found as static
     * @return Trait index or null
     */
    public GraphTargetItem findPropertyCallType(ABC abc, GraphTargetItem cls, String propName, int ns, boolean findStatic, boolean findInstance, boolean findProtected, Reference<Boolean> foundStatic) {
@@ -939,6 +942,7 @@ public final class AbcIndexing {
     * @param ts Traits
     * @param map Map to index
     * @param mapNs Map to index
+     * @param scriptIndex Script index
     */
    protected void indexTraits(ABC abc, int name_index, Traits ts, Map<PropertyDef, TraitIndex> map, Map<PropertyNsDef, TraitIndex> mapNs, int scriptIndex) {
        for (Trait t : ts.traits) {
--- a/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/action/ActionGraphTargetDialect.java
+++ b/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/action/ActionGraphTargetDialect.java
@@ -31,11 +31,14 @@ import java.util.ArrayList;
 import java.util.List;

 /**
- *
+ * AVM1 dialect.
 * @author JPEXS
 */
 public class ActionGraphTargetDialect extends GraphTargetDialect {

+    /**
+     * AVM1 dialect instance.
+     */
    public static final GraphTargetDialect INSTANCE = new ActionGraphTargetDialect();

    private ActionGraphTargetDialect() {
--- a/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/amf/amf0/types/ReferenceType.java
+++ b/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/amf/amf0/types/ReferenceType.java
@@ -17,7 +17,7 @@
 package com.jpexs.decompiler.flash.amf.amf0.types;

 /**
- *
+ * Reference type.
 * @author JPEXS
 */
 public class ReferenceType {
--- a/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/configuration/ConfigurationStorage.java
+++ b/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/configuration/ConfigurationStorage.java
@@ -19,7 +19,7 @@ package com.jpexs.decompiler.flash.configuration;
 import java.util.Map;

 /**
- *
+ * Class for storing configuration.
 * @author JPEXS
 */
 public interface ConfigurationStorage {
--- a/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/configuration/LegacyConfigurationStorage.java
+++ b/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/configuration/LegacyConfigurationStorage.java
@@ -30,7 +30,7 @@ import java.util.logging.Logger;
 import javax.swing.JOptionPane;

 /**
- *
+ * Legacy (binary file) configuration storage.
 * @author JPEXS
 */
 public class LegacyConfigurationStorage implements ConfigurationStorage {
--- a/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/configuration/TomlConfigurationStorage.java
+++ b/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/configuration/TomlConfigurationStorage.java
@@ -49,7 +49,7 @@ import org.tomlj.TomlParseResult;
 import org.tomlj.TomlTable;

 /**
- *
+ * TOML file confiraration storage.
 * @author JPEXS
 */
 public class TomlConfigurationStorage implements ConfigurationStorage {
--- a/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/configuration/enums/GridSnapAccuracy.java
+++ b/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/configuration/enums/GridSnapAccuracy.java
@@ -17,7 +17,7 @@
 package com.jpexs.decompiler.flash.configuration.enums;

 /**
- *
+ * Grid snap accuracy.
 * @author JPEXS
 */
 public enum GridSnapAccuracy {
--- a/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/configuration/enums/GuidesSnapAccuracy.java
+++ b/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/configuration/enums/GuidesSnapAccuracy.java
@@ -17,7 +17,7 @@
 package com.jpexs.decompiler.flash.configuration.enums;

 /**
- *
+ * Guides snap accuracy.
 * @author JPEXS
 */
 public enum GuidesSnapAccuracy {
--- a/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/jna/platform/win32/WinBase.java
+++ b/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/jna/platform/win32/WinBase.java
@@ -138,7 +138,7 @@ public interface WinBase extends StdCallLibrary, WinDef, BaseTSD {
    int HANDLE_FLAG_INHERIT = 1;

    /**
-     * If this flag is set, calling the {@link Kernel32#CloseHandle} function
+     * If this flag is set, calling the Kernel32 - CloseHandle function
     * will not close the object handle.
     */
    int HANDLE_FLAG_PROTECT_FROM_CLOSE = 2;
--- a/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/simpleparser/CatchScope.java
+++ b/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/simpleparser/CatchScope.java
@@ -20,7 +20,7 @@ import java.util.ArrayList;
 import java.util.List;

 /**
- *
+ * Catch (of try..catch) clause scope.
 * @author JPEXS
 */
 public class CatchScope implements Scope {
--- a/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/simpleparser/ClassScope.java
+++ b/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/simpleparser/ClassScope.java
@@ -20,7 +20,7 @@ import java.util.ArrayList;
 import java.util.List;

 /**
- *
+ * Class scope.
 * @author JPEXS
 */
 public class ClassScope implements Scope {
--- a/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/simpleparser/ClassTrait.java
+++ b/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/simpleparser/ClassTrait.java
@@ -17,6 +17,7 @@
 package com.jpexs.decompiler.flash.simpleparser;

 /**
+ * Class trait.
 * @author JPEXS
 */
 public class ClassTrait extends Variable {
--- a/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/simpleparser/FunctionScope.java
+++ b/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/simpleparser/FunctionScope.java
@@ -20,7 +20,7 @@ import java.util.ArrayList;
 import java.util.List;

 /**
- *
+ * Function scope.
 * @author JPEXS
 */
 public class FunctionScope implements Scope {
--- a/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/simpleparser/Import.java
+++ b/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/simpleparser/Import.java
@@ -17,7 +17,7 @@
 package com.jpexs.decompiler.flash.simpleparser;

 /**
- *
+ * Import statement.
 * @author JPEXS
 */
 public class Import extends Variable {
--- a/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/simpleparser/LinkHandler.java
+++ b/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/simpleparser/LinkHandler.java
@@ -17,6 +17,7 @@
 package com.jpexs.decompiler.flash.simpleparser;

 /**
+ * Handler of links.
 * @author JPEXS
 */
 public interface LinkHandler {
--- a/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/simpleparser/LinkType.java
+++ b/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/simpleparser/LinkType.java
@@ -17,7 +17,7 @@
 package com.jpexs.decompiler.flash.simpleparser;

 /**
- *
+ * Type of link.
 * @author JPEXS
 */
 public enum LinkType {
--- a/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/simpleparser/MethodScope.java
+++ b/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/simpleparser/MethodScope.java
@@ -19,7 +19,7 @@ package com.jpexs.decompiler.flash.simpleparser;
 import java.util.List;

 /**
- *
+ * Method scope.
 * @author JPEXS
 */
 public class MethodScope extends FunctionScope {
--- a/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/simpleparser/Namespace.java
+++ b/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/simpleparser/Namespace.java
@@ -17,7 +17,7 @@
 package com.jpexs.decompiler.flash.simpleparser;

 /**
- *
+ * Namespace.
 * @author JPEXS
 */
 public class Namespace extends Variable {
--- a/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/simpleparser/Scope.java
+++ b/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/simpleparser/Scope.java
@@ -19,7 +19,7 @@ package com.jpexs.decompiler.flash.simpleparser;
 import java.util.List;

 /**
- *
+ * Scope.
 * @author JPEXS
 */
 public interface Scope extends VariableOrScope {
--- a/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/simpleparser/SimpleParser.java
+++ b/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/simpleparser/SimpleParser.java
@@ -25,7 +25,7 @@ import java.util.Map;
 import java.util.Set;

 /**
- *
+ * Simple parser used for highlighting in editors.
 * @author JPEXS
 */
 public interface SimpleParser {
@@ -37,6 +37,12 @@ public interface SimpleParser {
     * @param definitionPosToReferences Definition position to references
     * @param referenceToDefinition Reference to definition
     * @param errors Errors
+     * @param externalTypes External types
+     * @param referenceToExternalTypeIndex Reference to external type index
+     * @param externalTypeIndexToReference External type index to reference
+     * @param linkHandler Link handler
+     * @param referenceToExternalTraitKey Reference to external trait key
+     * @param externalTraitKeyToReference External trait key to reference
     * @throws SimpleParseException On parse error
     * @throws IOException On I/O error
     * @throws InterruptedException On interrupt
--- a/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/simpleparser/TraitVarConstValueScope.java
+++ b/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/simpleparser/TraitVarConstValueScope.java
@@ -20,7 +20,7 @@ import java.util.ArrayList;
 import java.util.List;

 /**
- *
+ * Scope of value of var or const trait.
 * @author JPEXS
 */
 public class TraitVarConstValueScope implements Scope {
--- a/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/simpleparser/Type.java
+++ b/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/simpleparser/Type.java
@@ -17,7 +17,7 @@
 package com.jpexs.decompiler.flash.simpleparser;

 /**
- *
+ * Type.
 * @author JPEXS
 */
 public class Type extends Variable {
--- a/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/simpleparser/Variable.java
+++ b/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/simpleparser/Variable.java
@@ -20,7 +20,7 @@ import java.util.Arrays;
 import java.util.List;

 /**
- *
+ * Variable.
 * @author JPEXS
 */
 public class Variable implements VariableOrScope {
--- a/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/simpleparser/VariableOrScope.java
+++ b/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/simpleparser/VariableOrScope.java
@@ -17,7 +17,7 @@
 package com.jpexs.decompiler.flash.simpleparser;

 /**
- *
+ * Variable or scope.
 * @author JPEXS
 */
 public interface VariableOrScope {
--- a/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/sol/FilePathTag.java
+++ b/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/sol/FilePathTag.java
@@ -23,7 +23,7 @@ import java.io.IOException;
 import java.io.OutputStream;

 /**
- *
+ * File path tag.
 * @author JPEXS
 */
 public class FilePathTag extends Tag {
--- a/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/sol/LsoTag.java
+++ b/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/sol/LsoTag.java
@@ -31,11 +31,9 @@ import java.util.HashMap;
 import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
-import java.util.logging.Level;
-import java.util.logging.Logger;

 /**
- *
+ * Lso tag.
 * @author JPEXS
 */
 public class LsoTag extends Tag {
--- a/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/sol/SolFile.java
+++ b/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/sol/SolFile.java
@@ -38,7 +38,7 @@ import java.util.List;
 import java.util.Map;

 /**
- *
+ * Sol file.
 * @author JPEXS
 */
 public class SolFile {
--- a/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/sol/UnknownTag.java
+++ b/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/sol/UnknownTag.java
@@ -20,7 +20,7 @@ import java.io.IOException;
 import java.io.OutputStream;

 /**
- *
+ * Unknown tag.
 * @author JPEXS
 */
 public class UnknownTag extends Tag {
--- a/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/tags/Tag.java
+++ b/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/tags/Tag.java
@@ -564,8 +564,8 @@ public abstract class Tag implements NeedsCharacters, Exportable, Serializable {
    
    /**
     * Writes Tag value to the stream, ignoring all scripts
-     * @param sos
-     * @throws IOException 
+     * @param sos Output stream
+     * @throws IOException On I/O error
     */
    public void writeTagNoScripts(SWFOutputStream sos) throws IOException {
        byte[] newData = getDataNoScript();
--- a/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/tags/converters/PlaceObjectTypeConverter.java
+++ b/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/tags/converters/PlaceObjectTypeConverter.java
@@ -33,7 +33,7 @@ import com.jpexs.helpers.Helper;
 import java.util.List;

 /**
- *
+ * Converter of PlaceObject versions.
 * @author JPEXS
 */
 public class PlaceObjectTypeConverter {
--- a/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/tags/dynamictext/AdvancedTextRecord.java
+++ b/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/tags/dynamictext/AdvancedTextRecord.java
@@ -21,7 +21,7 @@ import com.jpexs.decompiler.flash.tags.base.FontTag;
 import com.jpexs.decompiler.flash.types.TEXTRECORD;

 /**
- *
+ * Text record with font class.
 * @author JPEXS
 */
 public class AdvancedTextRecord extends TEXTRECORD {
--- a/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/xfl/BinDataOutputStream.java
+++ b/libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/xfl/BinDataOutputStream.java
@@ -20,7 +20,7 @@ import java.io.IOException;
 import java.io.OutputStream;

 /**
- *
+ * Bin data file output stream.
 * @author JPEXS
 */
 public class BinDataOutputStream extends OutputStream {
--- a/libsrc/ffdec_lib/src/com/jpexs/decompiler/graph/GraphTargetDialect.java
+++ b/libsrc/ffdec_lib/src/com/jpexs/decompiler/graph/GraphTargetDialect.java
@@ -17,7 +17,7 @@
 package com.jpexs.decompiler.graph;

 /**
- *
+ * Dialect - high level language type.
 * @author JPEXS
 */
 public abstract class GraphTargetDialect {
@@ -31,8 +31,8 @@ public abstract class GraphTargetDialect {
    /**
     * Conversion of ECMA value (that's used in simplifications)
     * back to GraphTarget item.
-     * @param value
-     * @return 
+     * @param value Ecma value
+     * @return GraphTarget item
     */
    public abstract GraphTargetItem valToItem(Object value);
 }
--- a/libsrc/ffdec_lib/src/com/jpexs/decompiler/graph/GraphTargetItem.java
+++ b/libsrc/ffdec_lib/src/com/jpexs/decompiler/graph/GraphTargetItem.java
@@ -231,6 +231,7 @@ public abstract class GraphTargetItem implements Serializable, Cloneable {

    /**
     * Constructs GraphTargetItem
+     * @param dialect Dialect
     */
    public GraphTargetItem(GraphTargetDialect dialect) {
        this(dialect, null, null, NOPRECEDENCE);        
@@ -239,9 +240,10 @@ public abstract class GraphTargetItem implements Serializable, Cloneable {
    /**
     * Constructs GraphTargetItem
     *
+     * @param dialect Dialect
     * @param src Source item
     * @param lineStartItem Line start item
-     * @param precedence Precedence
+     * @param precedence Precedence     
     */
    public GraphTargetItem(GraphTargetDialect dialect, GraphSourceItem src, GraphSourceItem lineStartItem, int precedence) {
        this(dialect, src, lineStartItem, precedence, null);
@@ -250,6 +252,7 @@ public abstract class GraphTargetItem implements Serializable, Cloneable {
    /**
     * Constructs GraphTargetItem
     *
+     * @param dialect Dialect
     * @param src Source item
     * @param lineStartItem Line start item
     * @param precedence Precedence