Feature/new hook doc (#144)
* added hooks-param-buf-len doc file * showing help for hooks-param-buf-len * added hooks-param-set-buf-len
This commit is contained in:
		@@ -25,6 +25,8 @@ import hooksGuardInFor from "./md/hooks-guard-in-for.md";
 | 
			
		||||
import hooksGuardInWhile from "./md/hooks-guard-in-while.md";
 | 
			
		||||
import hooksHashBufLen from "./md/hooks-hash-buf-len.md";
 | 
			
		||||
import hooksKeyletBufLen from "./md/hooks-keylet-buf-len.md";
 | 
			
		||||
import hooksParamBufLen from "./md/hooks-param-buf-len.md";
 | 
			
		||||
import hooksParamSetBufLen from "./md/hooks-param-set-buf-len.md";
 | 
			
		||||
import hooksRaddrConvBufLen from "./md/hooks-raddr-conv-buf-len.md";
 | 
			
		||||
import hooksRaddrConvPure from "./md/hooks-raddr-conv-pure.md";
 | 
			
		||||
import hooksReserveLimit from "./md/hooks-reserve-limit.md";
 | 
			
		||||
@@ -69,6 +71,8 @@ const docs: { [key: string]: string; } = {
 | 
			
		||||
  "hooks-guard-in-while": hooksGuardInWhile,
 | 
			
		||||
  "hooks-hash-buf-len": hooksHashBufLen,
 | 
			
		||||
  "hooks-keylet-buf-len": hooksKeyletBufLen,
 | 
			
		||||
  "hooks-param-buf-len": hooksParamBufLen,
 | 
			
		||||
  "hooks-param-set-buf-len": hooksParamSetBufLen,
 | 
			
		||||
  "hooks-raddr-conv-buf-len": hooksRaddrConvBufLen,
 | 
			
		||||
  "hooks-raddr-conv-pure": hooksRaddrConvPure,
 | 
			
		||||
  "hooks-reserve-limit": hooksReserveLimit,
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										7
									
								
								xrpl-hooks-docs/md/hooks-param-buf-len.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										7
									
								
								xrpl-hooks-docs/md/hooks-param-buf-len.md
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,7 @@
 | 
			
		||||
# hooks-param-buf-len
 | 
			
		||||
 | 
			
		||||
Function [hook_param](https://xrpl-hooks.readme.io/v2.0/reference/hook_param) expects a limited-length name input and produces fixed-size value output.
 | 
			
		||||
 | 
			
		||||
This check warns about invalid sizes of input and output buffers (if they're specified by constants - variable parameters are ignored).
 | 
			
		||||
 | 
			
		||||
[Read more](https://xrpl-hooks.readme.io/v2.0/docs/parameters)
 | 
			
		||||
							
								
								
									
										7
									
								
								xrpl-hooks-docs/md/hooks-param-set-buf-len.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										7
									
								
								xrpl-hooks-docs/md/hooks-param-set-buf-len.md
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,7 @@
 | 
			
		||||
# hooks-param-set-buf-len
 | 
			
		||||
 | 
			
		||||
Function [hook_param_set](https://xrpl-hooks.readme.io/v2.0/reference/hook_param_set) expects limited-length name, fixed-length hash and limited-length value inputs.
 | 
			
		||||
 | 
			
		||||
This check warns about invalid sizes of input buffers (if they're specified by constants - variable parameters are ignored).
 | 
			
		||||
 | 
			
		||||
[Read more](https://xrpl-hooks.readme.io/v2.0/docs/parameters)
 | 
			
		||||
		Reference in New Issue
	
	Block a user