mirror of
				https://github.com/janet-lang/janet
				synced 2025-10-31 07:33:01 +00:00 
			
		
		
		
	Add lots of documentation for all functions.
This commit is contained in:
		| @@ -252,11 +252,33 @@ static int cfun_rawget(JanetArgs args) { | ||||
| } | ||||
|  | ||||
| static const JanetReg cfuns[] = { | ||||
|     {"table.new", cfun_new, NULL}, | ||||
|     {"table.to-struct", cfun_tostruct, NULL}, | ||||
|     {"table.getproto", cfun_getproto, NULL}, | ||||
|     {"table.setproto", cfun_setproto, NULL}, | ||||
|     {"table.rawget", cfun_rawget, NULL}, | ||||
|     {"table.new", cfun_new, | ||||
|         "(table.new capacity)\n\n" | ||||
|         "Creates a new empty table with pre-allocated memory " | ||||
|         "for capacity entries. This means that if one knows the number of " | ||||
|         "entries going to go in a table on creation, extra memory allocation " | ||||
|         "can be avoided. Returns the new table." | ||||
|     }, | ||||
|     {"table.to-struct", cfun_tostruct, | ||||
|         "(table.to-struct tab)\n\n" | ||||
|         "Convert a table to a struct. Returns a new struct. This function " | ||||
|         "does not take into account prototype tables." | ||||
|     }, | ||||
|     {"table.getproto", cfun_getproto, | ||||
|         "(table.getproto tab)\n\n" | ||||
|         "Get the prototype table of a table. Returns nil if a table " | ||||
|         "has no prototype, otherwise returns the prototype." | ||||
|     }, | ||||
|     {"table.setproto", cfun_setproto, | ||||
|         "(table.setproto tab proto)\n\n" | ||||
|         "Set the prototype of a table. Returns the original table tab." | ||||
|     }, | ||||
|     {"table.rawget", cfun_rawget, | ||||
|         "(table.rawget tab key)\n\n" | ||||
|         "Gets a value from a table without looking at the prototype table. " | ||||
|         "If a table tab does not contain t directly, the function will return " | ||||
|         "nil without checking the prototype. Returns the value in the table." | ||||
|     }, | ||||
|     {NULL, NULL, NULL} | ||||
| }; | ||||
|  | ||||
|   | ||||
		Reference in New Issue
	
	Block a user
	 Calvin Rose
					Calvin Rose