feat: new class builder docs

Author: hugeblank

docs/.vitepress/config.mts

@@ -47,6 +47,12 @@ export default defineConfig({
                     { text: 'Mixin Library', link: '/reference/mixin-lib' },
                     { text: 'Class Building', link: '/reference/class-building' },
                 ]
+            },
+            {
+                text: 'Asides',
+                items: [
+                    { text: 'Type Mapping Reference', link: '/reference/asides/type-table' }
+                ]
             }
         ],
 
@@ -71,8 +77,10 @@ export default defineConfig({
             }).use(footnote)
         },
         lineNumbers: true,
+        stripMarkersFromSnippets: true,
     },
 
+
     vite: {
         plugins: [
             groupIconVitePlugin({

docs/reference/type-table.md docs/reference/asides/type-table.mddocs/reference/type-table.md renamed to docs/reference/asides/type-table.md

@@ -5,20 +5,19 @@ prev:
 next: false
 ---
 
-# Type Mapping Reference
+# Aside - Type Mapping Reference
 
 |  Lua Type  |                                                                               Java Type                                                                               |
 | :--------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
-|   `nil`    |                                                                      `null`, `void`, `Void` [^1]                                                                      |
-|  `number`  |                               `byte`, `short`, `int`, `long`, `float`, `double`, `Byte`, `Short`, `Int`, `Long`, `Float`, `Double` [^2]                               |
+|   `nil`    |                                                                                `null`                                                                                 |
+|  `number`  |                               `byte`, `short`, `int`, `long`, `float`, `double`, `Byte`, `Short`, `Int`, `Long`, `Float`, `Double` [^1]                               |
 | `boolean`  |                                                                         `boolean`, `Boolean`                                                                          |
 |  `string`  |                                                                               `String`                                                                                |
-| `function` |                                                                            *instance* [^3]                                                                            |
-|  `table`   | [See Source code](https://github.com/moongardenmods/allium/blob/main/allium/src/main/java/dev/hugeblank/allium/loader/type/coercion/TypeCoercions.java#L315-L330)[^4] |
-| `userdata` |                                                                  *instance*, `Class`, `EClass` [^5]                                                                   |
+| `function` |                                                                            *instance* [^2]                                                                            |
+|  `table`   | [See Source code](https://github.com/moongardenmods/allium/blob/main/allium/src/main/java/dev/hugeblank/allium/loader/type/coercion/TypeCoercions.java#L315-L330)[^3] |
+| `userdata` |                                                                  *instance*, `Class`, `EClass` [^4]                                                                   |
 
-[^1]: Can only be used as `void` or `Void` when describing a method to create or override during class building.
-[^2]: If a number greater than the max size of the Java type is provided, it overflows, wrapping around. (ex. if passing 256 where a byte is expected, the resulting byte will be 0)
-[^3]: When going from Lua to Java, converted to an instance of a functional interface (java interface with only one method), where applicable. see [Callback Methods](#callback-methods)
-[^4]: When going from Java to Lua, converted only if the java method's return value is annotated with `@CoerceToNative`. When going from Lua to Java, converted unconditionally.
-[^5]: Java classes and objects are wrapped as userdata. Additionally, where a `Class` or `EClass` are expected, a userdata passed directly from `require` can be used.
+[^1]: If a number greater than the max size of the Java type is provided, it overflows, wrapping around. (ex. if passing 256 where a byte is expected, the resulting byte will be 0)
+[^2]: When going from Lua to Java, converted to an instance of a functional interface (java interface with only one method), where applicable. see [Callback Methods](#callback-methods)
+[^3]: When going from Java to Lua, converted only if the java method's return value is annotated with `@CoerceToNative`. When going from Lua to Java, converted unconditionally.
+[^4]: Java classes and objects are wrapped as userdata. Additionally, where a `Class` or `EClass` are expected, a userdata passed directly from `require` can be used.

docs/reference/builders/clinit.md

@@ -0,0 +1,31 @@
+---
+prev: 
+    text: 'Class Building - classBuilder:clinit()'
+    link: '/reference/class-building#classbuilder-clinit'
+next: false
+---
+
+
+# Class Initializer Builder
+
+Class initializers are invoked on class load, and are meant to set static variables that do not have a pre-defined value.
+
+## `clinitBuilder:index(index)`
+
+Adds an index to this class initializer that is used instead of the default name `initializer` when running `classBuilder:define()`.
+
+### Parameters
+
+1. `index` - `string`: A unique index that will be used as the name of the handler function in the table provided to `classBuilder:define()`.
+
+### Returns
+
+- `userdata [instance]` This class initializer builder.
+
+## `clinitBuilder:build()`
+
+Finalize the class initializer, preparing it for definition in `classBuilder:define()`.
+
+### Returns
+
+- `userdata [instance]` The class builder for which this class initializer is being built for.

docs/reference/builders/constructor.md

@@ -0,0 +1,99 @@
+---
+prev: 
+    text: 'Class Building - classBuilder:constructor()'
+    link: '/reference/class-building#classbuilder-constructor'
+next: false
+---
+
+# Constructor Builder
+
+## `constructorBuilder:index(index)`
+
+Adds an index to this constructor that is used instead of the default name `constructor` when running `classBuilder:define()`.
+
+### Parameters
+
+1. `index` - `string`: A unique index that will be used as the name of the method in the table provided to `classBuilder:define()`.
+
+### Returns
+
+- `userdata [instance]` This constructor builder.
+
+## `constructorBuilder:access(access)`
+
+Defines this constructors access. If no access table is provided, the default `package-private` scope is used.
+
+### Parameters
+
+1. `access` - `table`: Access flags for the constructor. See [Access Modifier Table](#access-modifier-table)
+
+### Returns
+
+- `userdata [instance]` This constructor builder.
+
+## `constructorBuilder:this(params)`
+
+Indicates that this constructor should initialize using another constructor within this class.
+
+### Parameters
+
+1. `params` - `table<userdata [class]>`: The parameters of the `this` constructor.
+
+### Returns
+
+- `userdata [instance]` This constructor builder.
+
+## `constructorBuilder:super(params)`
+
+Indicates that this constructor should initialize using one of the parent's class constructors.
+
+### Parameters
+
+1. `params` - `table<userdata [class]>`: The parameters of the `super` constructor.
+
+### Returns
+
+- `userdata [instance]` This constructor builder.
+
+## `constructorBuilder:parameters(params)`
+
+Defines the parameters of this constructor. If omitted, defaults to the parameters of the `this` or `super` constructor, whichever is defined.
+If the parameters of the constructor being built, and `super` or `this` constructor match, parameters do not need to be defined.
+
+### Parameters
+
+1. `params` - `table<userdata [class]>`: The parameters of the constructor.
+
+### Returns
+
+- `userdata [instance]` This constructor builder.
+
+## `constructorBuilder:remapper(func)`
+
+Function that allows for the parameters of the constructor being built to be adapted to the `this` or `super` constructor, whichever is defined.
+If the parameters of the constructor being built, and `super` or `this` constructor match, a remapper function is not needed.
+
+### Parameters
+
+1. `remapper` - `function?`: An function that accepts the parameters of the constructor that will eventually be built. Returns what will be fed into the `super` or `this` constructor.
+
+### Returns
+
+- `userdata [instance]` This constructor builder.
+
+## `constructorBuilder:definesFields()`
+
+Indicates that this constructor will define instance fields. Constructors without this method invoked will not be able to define fields.
+If invoked, Instance fields created by `classBuilder:field()` that do not have a default value must be initialized in this constructor.
+
+### Returns
+
+- `userdata [instance]` This constructor builder.
+
+## `constructorBuilder:build()`
+
+### Returns
+
+- `userdata [instance]` The class builder for which this constructor is being built for.
+
+Finalize the constructor, preparing it for definition in `classBuilder:define()`.

docs/reference/builders/method.md

@@ -0,0 +1,98 @@
+---
+prev: 
+    text: 'Class Building - classBuilder:method()'
+    link: '/reference/class-building#classbuilder-method'
+next: false
+---
+
+# Method Builder
+
+## `methodBuilder:index(index)`
+
+Adds an index to this method that is used instead of the method name when running `classBuilder:define()`.
+
+### Parameters
+
+1. `index` - `string`: A unique index that will be used as the name of the handler function in the table provided to `classBuilder:define()`.
+
+### Returns
+
+- `userdata [instance]` This method builder.
+
+## `methodBuilder:override(name, params)`
+
+Overrides a method in the parent class. 
+
+If provided, `methodBuilder:name()`, `methodBuilder:params()`, and `methodBuilder:returnType()` must not be used, 
+and `methodBuilder:access()` can only be used to maintain or increase the scope of the method, never decrease.
+
+### Parameters
+
+1. `name` - `string`: The name of the method to override.
+1. `params` - `table<userdata [class]>`: The parameters of the method to override.
+
+### Returns
+
+- `userdata [instance]` This method builder.
+
+## `methodBuilder:access(access)`
+
+Defines this methods access. If no access table is provided, the default `package-private` scope is used.
+
+If the method to be created is abstract, a function defintion must not be submitted.
+
+If the method is not static then `self` represents `this`. 
+
+If the method is static then `self` reprents a `userdata [class]` of the class being built, with access to all static fields.
+
+### Parameters
+
+1. `access` - `table`: Access flags for the method. See [Access Modifier Table](#access-modifier-table)
+
+### Returns
+
+- `userdata [instance]` This method builder.
+
+## `methodBuilder:name(name)`
+
+Define a name for the method to be created.
+
+### Parameters
+
+1. `name` - `string`: The method name.
+
+### Returns
+
+- `userdata [instance]` This method builder.
+
+## `methodBuilder:parameters(params)`
+
+Defines the parameters of this method.
+
+### Parameters
+
+1. `params` - `table<userdata [class]>`: The parameters of the method.
+
+### Returns
+
+- `userdata [instance]` This method builder.
+
+## `methodBuilder:returnType(returnType)`
+
+Defines the return type of this method.
+
+### Parameters
+
+1. `returnType` - `userdata [class]`: The return type of the method.
+
+### Returns
+
+- `userdata [instance]` This method builder.
+
+## `methodBuilder:build()`
+
+Finalize the method, preparing it for definition in `classBuilder:define()`.
+
+### Returns
+
+- `userdata [instance]` The class builder for which this method is being built for.