Factory Descriptions

[inspectredc]

I think with each factory some documentation for an example yaml (or something which achieves the same purpose, e.g. doxygen comments) which explain the params which are required and are available for the factory. I'm not too familiar with documenting formats but have given an attempt at what I hope is a good example below. If we keep a 'fill in the blanks' example in the example factory then this will be easier to encourage people to use when creating factories.

/*
 * Factory: VtxFactory
 *
 * -- Required --
 * @node name: - specifies the name of the asset node/file, typically this should match the symbol field
 * @field type: - specifies the type of factory. must be `VTX` for this factory
 * @field count: - specifies the number of vertices in the vertex array
 * @field offset: - specifies the offset of the asset in the file. vram offsets require additional fields in the config
 * @field symbol: - specifies the symbol used in the code for this asset, typically this should match the node name
 * 
 * asset_seg7_vertex_0702A948:
 *   type: VTX
 *   count: 4
 *   offset: 0x2A948
 *   symbol: asset_seg7_vertex_0702A948
 *
 */

[MegaMech]

I second this