Annotations documentation.

This commit is contained in:
Jindra Petřík
2024-08-06 04:19:57 +02:00
parent 1331a7d73b
commit 29389e47ce
14 changed files with 37 additions and 14 deletions

View File

@@ -23,7 +23,7 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
*
* Describes available value from enum
* @author JPEXS
*/
@Retention(RetentionPolicy.RUNTIME)
@@ -31,10 +31,21 @@ import java.lang.annotation.Target;
@Repeatable(EnumValues.class)
public @interface EnumValue {
/**
* Value.
* @return
*/
int value();
/**
* Description.
* @return
*/
String text();
// todo: check in generic tag editor
/**
* Minimum SWF version.
* TODO: check in generic tag editor
*/
int minSwfVersion() default 1;
}

View File

@@ -22,7 +22,7 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
*
* List of available enum values.
* @author JPEXS
*/
@Retention(RetentionPolicy.RUNTIME)

View File

@@ -17,7 +17,7 @@
package com.jpexs.decompiler.flash.types.annotations;
/**
*
* Type of hash.
* @author JPEXS
*/
public enum HashType {

View File

@@ -22,7 +22,7 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
*
* Hide in raw edit.
* @author JPEXS
*/
@Retention(RetentionPolicy.RUNTIME)

View File

@@ -22,7 +22,7 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Field is internal
* Field is internal.
*
* @author JPEXS
*/

View File

@@ -22,7 +22,7 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* The String field can have large multiline text
* The String field can have large multiline text.
*
* @author JPEXS
*/

View File

@@ -22,7 +22,7 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* The field is optional anc can be unset
* The field is optional anc can be unset.
*
* @author JPEXS
*/

View File

@@ -22,7 +22,7 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Field is reserved
* Field is reserved.
*
* @author JPEXS
*/

View File

@@ -22,7 +22,7 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Marks array and list fields
* Marks array and list fields.
*
* @author JPEXS
*/

View File

@@ -22,7 +22,7 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
*
* The field is defined in SWF.
* @author JPEXS
*/
@Retention(RetentionPolicy.RUNTIME)

View File

@@ -23,7 +23,7 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Maps basic java types (int,float,double) to SWF types (UI8,UI16...FLOAT)
* Maps basic java types (int,float,double) to SWF types (UI8,UI16...FLOAT).
*
* @author JPEXS
*/

View File

@@ -22,7 +22,7 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Target SWF version
* Target SWF version.
*
* @author JPEXS
*/

View File

@@ -22,14 +22,22 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
*
* The item is table of values.
* @author JPEXS
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface Table {
/**
* Table name.
* @return
*/
String value();
/**
* One item name.
* @return
*/
String itemName() default "";
}

View File

@@ -21,6 +21,10 @@ import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* It's an UUID.
* @author JPEXS
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface UUID {