fix javadocs in tlb type classes

neodix42 · Sep 7, 2024 · 7b5056a · 7b5056a
1 parent d121aae
commit 7b5056a
Show file tree

Hide file tree

Showing 124 changed files with 791 additions and 460 deletions.
diff --git a/cell/src/main/java/org/ton/java/tlb/types/AccountBlock.java b/cell/src/main/java/org/ton/java/tlb/types/AccountBlock.java
@@ -11,17 +11,20 @@
 
 import java.math.BigInteger;
 
-@Builder
-@Getter
-@Setter
-@ToString
 /**
+ * <pre>
  * acc_trans#5
  *  account_addr:bits256
  *  transactions:(HashmapAug 64 ^Transaction CurrencyCollection)
  *  state_update:^(HASH_UPDATE Account)
  *  = AccountBlock;
+ *  </pre>
  */
+@Builder
+@Getter
+@Setter
+@ToString
+
 public class AccountBlock {
     long magic;
     BigInteger addr;

diff --git a/cell/src/main/java/org/ton/java/tlb/types/AccountStorage.java b/cell/src/main/java/org/ton/java/tlb/types/AccountStorage.java
@@ -10,17 +10,20 @@
 
 import java.math.BigInteger;
 
-@Builder
-@Getter
-@Setter
-@ToString
 /**
+ * <pre>
  * account_storage$_
  *     last_trans_lt:uint64
  *     balance:CurrencyCollection
  *     state:AccountState
  *   = AccountStorage;
+ *   </pre>
  */
+@Builder
+@Getter
+@Setter
+@ToString
+
 public class AccountStorage {
     String accountStatus;
     BigInteger lastTransactionLt;

diff --git a/cell/src/main/java/org/ton/java/tlb/types/ActionPhase.java b/cell/src/main/java/org/ton/java/tlb/types/ActionPhase.java
@@ -10,11 +10,8 @@
 
 import java.math.BigInteger;
 
-@Builder
-@Getter
-@Setter
-@ToString
 /**
+ * <pre>
  * tr_phase_action$_
  *   success:Bool
  *   valid:Bool
@@ -31,7 +28,13 @@
  *   action_list_hash:bits256
  *   tot_msg_size:StorageUsedShort
  *   = TrActionPhase;
+ *   </pre>
  */
+@Builder
+@Getter
+@Setter
+@ToString
+
 public class ActionPhase {
     boolean success;
     boolean valid;

diff --git a/cell/src/main/java/org/ton/java/tlb/types/ActionReserveCurrency.java b/cell/src/main/java/org/ton/java/tlb/types/ActionReserveCurrency.java
@@ -8,13 +8,14 @@
 import org.ton.java.cell.CellBuilder;
 import org.ton.java.cell.CellSlice;
 
+/**
+ * action_reserve_currency#36e6b809 mode:(## 8) currency:CurrencyCollection = OutAction;
+ */
 @Builder
 @Getter
 @Setter
 @ToString
-/**
- action_reserve_currency#36e6b809 mode:(## 8) currency:CurrencyCollection = OutAction;
- */
+
 public class ActionReserveCurrency implements OutAction {
     long magic;
     int mode;

diff --git a/cell/src/main/java/org/ton/java/tlb/types/ActionSendMsg.java b/cell/src/main/java/org/ton/java/tlb/types/ActionSendMsg.java
@@ -8,13 +8,14 @@
 import org.ton.java.cell.CellBuilder;
 import org.ton.java.cell.CellSlice;
 
+/**
+ * action_send_msg#0ec3c86d mode:(## 8) out_msg:^(MessageRelaxed Any) = OutAction;
+ */
 @Builder
 @Getter
 @Setter
 @ToString
-/**
- action_send_msg#0ec3c86d mode:(## 8) out_msg:^(MessageRelaxed Any) = OutAction;
- */
+
 public class ActionSendMsg implements OutAction {
     long magic;
     int mode;

diff --git a/cell/src/main/java/org/ton/java/tlb/types/ActionSetCode.java b/cell/src/main/java/org/ton/java/tlb/types/ActionSetCode.java
@@ -8,13 +8,16 @@
 import org.ton.java.cell.CellBuilder;
 import org.ton.java.cell.CellSlice;
 
+/**
+ * <pre>
+ * action_set_code#ad4de08e new_code:^Cell = OutAction;
+ * </pre>
+ */
 @Builder
 @Getter
 @Setter
 @ToString
-/**
- action_set_code#ad4de08e new_code:^Cell = OutAction;
- */
+
 public class ActionSetCode implements OutAction {
     long magic;
     Cell newCode;

diff --git a/cell/src/main/java/org/ton/java/tlb/types/Anycast.java b/cell/src/main/java/org/ton/java/tlb/types/Anycast.java
@@ -8,16 +8,19 @@
 import org.ton.java.cell.CellBuilder;
 import org.ton.java.cell.CellSlice;
 
-@Builder
-@Getter
-@Setter
-@ToString
 /**
+ * <pre>
  * anycast_info$_
  *  depth:(#<= 30) { depth >= 1 }
  *  rewrite_pfx:(bits depth)
  *  = Anycast;
+ *  </pre>
  */
+@Builder
+@Getter
+@Setter
+@ToString
+
 public class Anycast {
     int depth; // 5 bits
     byte rewritePfx;

diff --git a/cell/src/main/java/org/ton/java/tlb/types/Block.java b/cell/src/main/java/org/ton/java/tlb/types/Block.java
@@ -8,18 +8,21 @@
 import org.ton.java.cell.CellBuilder;
 import org.ton.java.cell.CellSlice;
 
-@Builder
-@Getter
-@Setter
-@ToString
 /**
+ * <pre>
  * block#11ef55aa
  *   global_id:int32
  *   info:^BlockInfo
  *   value_flow:^ValueFlow
  *   state_update:^(MERKLE_UPDATE ShardState)
  *   extra:^BlockExtra = Block;
+ *   </pre>
  */
+@Builder
+@Getter
+@Setter
+@ToString
+
 public class Block {
     long magic;
     int globalId;

diff --git a/cell/src/main/java/org/ton/java/tlb/types/BlockCreateStats.java b/cell/src/main/java/org/ton/java/tlb/types/BlockCreateStats.java
@@ -4,8 +4,10 @@
 import org.ton.java.cell.CellSlice;
 
 /**
+ * <pre>
  * block_create_stats#17 counters:(HashmapE 256 CreatorStats) = BlockCreateStats;
  * block_create_stats_ext#34 counters:(HashmapAugE 256 CreatorStats uint32) = BlockCreateStats;
+ * </pre>
  */
 
 public interface BlockCreateStats {

diff --git a/cell/src/main/java/org/ton/java/tlb/types/BlockCreateStatsExt.java b/cell/src/main/java/org/ton/java/tlb/types/BlockCreateStatsExt.java
@@ -10,7 +10,9 @@
 import org.ton.java.cell.TonHashMapAugE;
 
 /**
+ * <pre>
  * block_create_stats_ext#34 counters:(HashmapAugE 256 CreatorStats uint32) = BlockCreateStats;
+ * </pre>
  */
 
 @Builder

diff --git a/cell/src/main/java/org/ton/java/tlb/types/BlockCreateStatsOrdinary.java b/cell/src/main/java/org/ton/java/tlb/types/BlockCreateStatsOrdinary.java
@@ -10,7 +10,9 @@
 import org.ton.java.cell.TonHashMapE;
 
 /**
+ * <pre>
  * block_create_stats#17 counters:(HashmapE 256 CreatorStats) = BlockCreateStats;
+ * </pre>
  */
 
 @Builder

diff --git a/cell/src/main/java/org/ton/java/tlb/types/BlockIdExtShardIdent.java b/cell/src/main/java/org/ton/java/tlb/types/BlockIdExtShardIdent.java
@@ -9,16 +9,19 @@
 
 import java.math.BigInteger;
 
-@ToString
-@Builder
-@Getter
 /**
+ * <pre>
  * block_id_ext$_
  *   shard_id:ShardIdent
  *   seq_no:uint32
  *   root_hash:bits256
  *   file_hash:bits256 = BlockIdExt;
+ *   </pre>
  */
+@ToString
+@Builder
+@Getter
+
 public class BlockIdExtShardIdent {
     //    int workchain;
 //    long shard;

diff --git a/cell/src/main/java/org/ton/java/tlb/types/BlockInfo.java b/cell/src/main/java/org/ton/java/tlb/types/BlockInfo.java
@@ -10,11 +10,8 @@
 
 import java.math.BigInteger;
 
-@Builder
-@Getter
-@Setter
-@ToString
 /**
+ * <pre>
  * block_info#9bc7a987
  *   version:uint32
  *   not_master:(## 1)
@@ -42,7 +39,13 @@
  *   prev_ref:^(BlkPrevInfo after_merge)
  *   prev_vert_ref:vert_seqno_incr?^(BlkPrevInfo 0)
  *   = BlockInfo;
+ *   <pre>
  */
+@Builder
+@Getter
+@Setter
+@ToString
+
 public class BlockInfo {
     long magic;
     long version;

diff --git a/cell/src/main/java/org/ton/java/tlb/types/BlockProof.java b/cell/src/main/java/org/ton/java/tlb/types/BlockProof.java
@@ -8,16 +8,19 @@
 import org.ton.java.cell.CellBuilder;
 import org.ton.java.cell.CellSlice;
 
-@Builder
-@Getter
-@Setter
-@ToString
 /**
+ * <pre>
  * block_proof#c3
  * proof_for:BlockIdExt
  * root:^Cell
  * signatures:(Maybe ^BlockSignatures) = BlockProof;
+ * </pre>
  */
+@Builder
+@Getter
+@Setter
+@ToString
+
 public class BlockProof {
     int magic;
     BlockIdExtShardIdent proofFor;

diff --git a/cell/src/main/java/org/ton/java/tlb/types/BlockSignatures.java b/cell/src/main/java/org/ton/java/tlb/types/BlockSignatures.java
@@ -8,16 +8,19 @@
 import org.ton.java.cell.CellBuilder;
 import org.ton.java.cell.CellSlice;
 
+/**
+ * <pre>
+ * block_signatures#11
+ * validator_info:ValidatorBaseInfo
+ * pure_signatures:BlockSignaturesPure
+ * = BlockSignatures;
+ * </pre>
+ */
 @Builder
 @Getter
 @Setter
 @ToString
-/**
- block_signatures#11
- validator_info:ValidatorBaseInfo
- pure_signatures:BlockSignaturesPure
- = BlockSignatures;
- */
+
 public class BlockSignatures {
     int magic;
     ValidatorBaseInfo validatorBaseInfo;

diff --git a/cell/src/main/java/org/ton/java/tlb/types/BlockSignaturesPure.java b/cell/src/main/java/org/ton/java/tlb/types/BlockSignaturesPure.java
@@ -11,14 +11,17 @@
 
 import java.math.BigInteger;
 
+/**
+ * <pre>
+ * block_signatures_pure#_ sig_count:uint32 sig_weight:uint64
+ * signatures:(HashmapE 16 CryptoSignaturePair) = BlockSignaturesPure;
+ * </pre>
+ */
 @Builder
 @Getter
 @Setter
 @ToString
-/**
- block_signatures_pure#_ sig_count:uint32 sig_weight:uint64
- signatures:(HashmapE 16 CryptoSignaturePair) = BlockSignaturesPure;
- */
+
 public class BlockSignaturesPure {
     long sigCount;
     BigInteger sigWeight;

diff --git a/cell/src/main/java/org/ton/java/tlb/types/Boc.java b/cell/src/main/java/org/ton/java/tlb/types/Boc.java
@@ -13,6 +13,7 @@
 import java.util.List;
 
 /**
+ * <pre>
  * serialized_boc#b5ee9c72
  * has_idx:(## 1)
  * has_crc32c:(## 1)
@@ -29,6 +30,7 @@
  * cell_data:(tot_cells_size * [ uint8 ])
  * crc32c:has_crc32c?uint32
  * = BagOfCells;
+ * </pre>
  */
 @Builder
 @Getter

diff --git a/cell/src/main/java/org/ton/java/tlb/types/BouncePhaseNegFounds.java b/cell/src/main/java/org/ton/java/tlb/types/BouncePhaseNegFounds.java
@@ -8,13 +8,16 @@
 import org.ton.java.cell.CellBuilder;
 import org.ton.java.cell.CellSlice;
 
+/**
+ * <pre>
+ * tr_phase_bounce_negfunds$00 = TrBouncePhase;
+ * </pre>
+ */
 @Builder
 @Getter
 @Setter
 @ToString
-/**
- * tr_phase_bounce_negfunds$00 = TrBouncePhase;
- */
+
 public class BouncePhaseNegFounds implements BouncePhase {
     int magic;
 

diff --git a/cell/src/main/java/org/ton/java/tlb/types/BouncePhaseNoFounds.java b/cell/src/main/java/org/ton/java/tlb/types/BouncePhaseNoFounds.java
@@ -10,15 +10,18 @@
 
 import java.math.BigInteger;
 
-@Builder
-@Getter
-@Setter
-@ToString
 /**
+ * <pre>
  * tr_phase_bounce_nofunds$01
  *   msg_size:StorageUsedShort
  *   req_fwd_fees:Grams = TrBouncePhase;
+ *   </pre>
  */
+@Builder
+@Getter
+@Setter
+@ToString
+
 public class BouncePhaseNoFounds implements BouncePhase {
     int magic;
     StorageUsedShort msgSize;
-Original file line number
+Diff line change
@@ Expand Up / @@ -10,7 +10,9 @@ @@
     import org.ton.java.cell.TonHashMapAugE;
     /**
+     * <pre>
      * block_create_stats_ext#34 counters:(HashmapAugE 256 CreatorStats uint32) = BlockCreateStats;
+     * </pre>
      */
     @Builder
@@ Expand Down @@