Add annotations

[Mingun]

Runtime changes for https://github.com/kaitai-io/kaitai_struct_compiler/pull/191

[Mingun]

One minor note: how can I build my branches? http://doc.kaitai.io/developers.html recommends checkout https://github.com/kaitai-io/kaitai_struct, but there will not be my changes, because they are in my fork of submodule projects (https://github.com/Mingun/kaitai_struct_java_runtime and https://github.com/Mingun/kaitai_struct_compiler). Also, how to create a stage build and run tests?

[GreyCat]

One minor note: how can I build my branches? http://doc.kaitai.io/developers.html recommends checkout https://github.com/kaitai-io/kaitai_struct, but there will not be my changes, because they are in my fork of submodule projects (https://github.com/Mingun/kaitai_struct_java_runtime and https://github.com/Mingun/kaitai_struct_compiler). Also, how to create a stage build and run tests?

"kaitai_struct", being what we call "an umbrella project", is essentially just an empty git repo which is used to bring all other repos in some pre-set directory layout to your machine.

You can easily clone https://github.com/kaitai-io/kaitai_struct, and then replace contents of compiler/ with https://github.com/Mingun/kaitai_struct_compiler and runtime/java/ with https://github.com/Mingun/kaitai_struct_java_runtime. That will give you the very same environment, but with your changes.

Once that's done, basically what you do is:

• tests/build-compiler to build the compiler
• tests/build-formats to convert all test .ksy formats into all target languages (including Java), which will give you tests/compiled/java
• tests/run-java will run all the tests for Java; results will be in tests/test_out/java

[Mingun]

Thank you for your explanations! Later I systemize my experience and send a PR to doc repository with instructions, how to work on project.

[Mingun]

So what the status of this?

[GreyCat]

Overall, it seems solid and useful. However, the devil is in the details:

• Documentation strings need major overhaul for grammar and brevity.
• We might want to review the terminology.

For now, let's go ahead with what we have. I'll try to formalize the terms in future.

[Mingun]

Thanks!