File Format Documentation

[chutchinson]

It is crucial that we document both the legacy and the newly engineered file formats. This project is comprised of the asset pipeline and serialization common to the editor, engine, and future potential projects.

[goblinJoel]

Is there a way to make automated documentation? The JSON stuff at least is pretty uniform. You have a method to populate the JSON object for the specific type that you're serializing, and it adds keys and values. Harvesting works similarly. But I expect there aren't tools to convert a series of json.key("foo").optString(thing.getFoo()); into a table of [field: "foo" | type: String | value: thing.getFoo()].

It would just be nice to have a way of ensuring the documentation is always current, since JSON is easy to change.