Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

User guide documentation update #5

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

User guide documentation update #5

wants to merge 6 commits into from

Commits on Apr 11, 2017

  1. user_guide: demonstrate use of hexadecimal notation in enums 

    Add an example showing how to use hexadecimal notation when defining
enumerations (enums).
    @davidhicks
    davidhicks committed Apr 11, 2017
    Configuration menu
    Copy the full SHA
    20a399b View commit details
    Browse the repository at this point in the history

  2. user_guide: add example for use of _parent

    @davidhicks
    davidhicks committed Apr 11, 2017
    Configuration menu
    Copy the full SHA
    e8e3fe2 View commit details
    Browse the repository at this point in the history

  3. user_guide: demonstrate reference to enum values by id 

    Add an example to show how enumeration values can be referred to in
switch-on/cases constructs by identifier instead of integer value.
    @davidhicks
    davidhicks committed Apr 11, 2017
    Configuration menu
    Copy the full SHA
    e5a6375 View commit details
    Browse the repository at this point in the history

  4. user_guide: add section on streams and substreams 

    This is a first attempt at describing how streams and substreams work
in Kaitai Struct. This documentation is based on advice provided at:
kaitai-io/kaitai_struct#145 (comment)
    @davidhicks
    davidhicks committed Apr 11, 2017
    Configuration menu
    Copy the full SHA
    78f6e58 View commit details
    Browse the repository at this point in the history

  5. user_guide: add pitfall section on size/substreams

    @davidhicks
    davidhicks committed Apr 11, 2017
    Configuration menu
    Copy the full SHA
    5f258c8 View commit details
    Browse the repository at this point in the history

  6. user_guide: add min/max methods for arrays 

    Reflects changes made in kaitai-io/kaitai_struct_compiler@ba114f2
    @davidhicks
    davidhicks committed Apr 11, 2017
    Configuration menu
    Copy the full SHA
    25e86c7 View commit details
    Browse the repository at this point in the history