More documentation.

libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/helpers/SWFDecompilerAdapter.java

@@ -22,51 +22,84 @@ import com.jpexs.decompiler.flash.abc.types.MethodBody;
 import com.jpexs.decompiler.flash.abc.types.traits.Trait;
 import com.jpexs.decompiler.flash.action.ActionList;
 import com.jpexs.decompiler.graph.GraphTargetItem;
+
 import java.util.List;
 
 /**
- *
+ * Adapter for SWFDecompilerListener
  * @author JPEXS
  */
 public class SWFDecompilerAdapter implements SWFDecompilerListener {
 
+    /**
+     * Called when a file is proxied
+     * @param data file data
+     * @return proxied file data
+     */
     @Override
     public byte[] proxyFileCatched(byte[] data) {
         return null;
     }
 
+    /**
+     * Called when a SWF file is parsed
+     * @param swf SWF object
+     */
     @Override
     public void swfParsed(SWF swf) {
     }
 
+    /**
+     * Called when an action list is parsed
+     * @param actions Action list
+     * @param swf SWF object
+     * @throws InterruptedException
+     */
     @Override
     public void actionListParsed(ActionList actions, SWF swf) throws InterruptedException {
     }
 
+    /**
+     * Called when an action tree is created
+     * @param tree Action tree
+     * @param swf SWF object
+     * @throws InterruptedException
+     */
     @Override
     public void actionTreeCreated(List<GraphTargetItem> tree, SWF swf) throws InterruptedException {
     }
 
+    /**
+     * Called when an ABC is parsed
+     * @param abc ABC object
+     * @param swf SWF object
+     */
     @Override
     public void abcParsed(ABC abc, SWF swf) {
     }
 
+    /**
+     * Called when a method body is parsed
+     * @param abc ABC object
+     * @param body Method body
+     * @param swf SWF object
+     */
     @Override
     public void methodBodyParsed(ABC abc, MethodBody body, SWF swf) {
     }
 
     /**
      * This method is only called when deobfuscation is enabled and new
-     * deobfuscation mode is selected
+     * deobfuscation mode is selected.
      *
-     * @param path
-     * @param classIndex
-     * @param isStatic
-     * @param scriptIndex
-     * @param abc
-     * @param trait
-     * @param methodInfo
-     * @param body
+     * @param path Path
+     * @param classIndex Class index
+     * @param isStatic Is static
+     * @param scriptIndex Script index
+     * @param abc ABC object
+     * @param trait Trait object
+     * @param methodInfo Method info
+     * @param body Method body
      * @throws InterruptedException
      */
     @Override

libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/helpers/SWFDecompilerListener.java

@@ -22,38 +22,71 @@ import com.jpexs.decompiler.flash.abc.types.MethodBody;
 import com.jpexs.decompiler.flash.abc.types.traits.Trait;
 import com.jpexs.decompiler.flash.action.ActionList;
 import com.jpexs.decompiler.graph.GraphTargetItem;
+
 import java.util.List;
 
 /**
- *
+ * Listener for SWF decompiler events.
  * @author JPEXS
  */
 public interface SWFDecompilerListener {
 
+    /**
+     * Called when a file is proxied
+     * @param data file data
+     * @return proxied file data
+     */
     byte[] proxyFileCatched(byte[] data);
 
+    /**
+     * Called when a SWF file is parsed
+     * @param swf SWF object
+     */
     void swfParsed(SWF swf);
 
+    /**
+     * Called when an action list is parsed
+     * @param actions Action list
+     * @param swf SWF object
+     * @throws InterruptedException
+     */
     void actionListParsed(ActionList actions, SWF swf) throws InterruptedException;
 
+    /**
+     * Called when an action tree is created
+     * @param tree Action tree
+     * @param swf SWF object
+     * @throws InterruptedException
+     */
     void actionTreeCreated(List<GraphTargetItem> tree, SWF swf) throws InterruptedException;
 
+    /**
+     * Called when an ABC is parsed
+     * @param abc ABC object
+     * @param swf SWF object
+     */
     void abcParsed(ABC abc, SWF swf);
 
+    /**
+     * Called when a method body is parsed
+     * @param abc ABC object
+     * @param body Method body
+     * @param swf SWF object
+     */
     void methodBodyParsed(ABC abc, MethodBody body, SWF swf);
 
     /**
-     * this method is only called when deobfuscation is enabled and new
-     * deobfuscation mode is selected
+     * This method is only called when deobfuscation is enabled and new
+     * deobfuscation mode is selected.
      *
-     * @param path
-     * @param classIndex
-     * @param isStatic
-     * @param scriptIndex
-     * @param abc
-     * @param trait
-     * @param methodInfo
-     * @param body
+     * @param path Path
+     * @param classIndex Class index
+     * @param isStatic Is static
+     * @param scriptIndex Script index
+     * @param abc ABC object
+     * @param trait Trait object
+     * @param methodInfo Method info
+     * @param body Method body
      * @throws InterruptedException
      */
     void avm2CodeRemoveTraps(String path, int classIndex, boolean isStatic, int scriptIndex, ABC abc, Trait trait, int methodInfo, MethodBody body) throws InterruptedException;

libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/helpers/collections/package-info.java

@@ -0,0 +1,4 @@
+/**
+ * Collection helpers.
+ */
+package com.jpexs.decompiler.flash.helpers.collections;

libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/helpers/hilight/package-info.java

@@ -0,0 +1,4 @@
+/**
+ * Code position highlighting.
+ */
+package com.jpexs.decompiler.flash.helpers.hilight;

libsrc/ffdec_lib/src/com/jpexs/decompiler/flash/helpers/package-info.java

@@ -0,0 +1,4 @@
+/**
+ * Helpers for flash.
+ */
+package com.jpexs.decompiler.flash.helpers;