Welcome to ATD’s documentation!

• Tutorial
  • What is atdgen?
  • What are the advantages of atdgen?
  • Prerequisites
  • Getting started
  • Inspecting and pretty-printing JSON
  • Inspecting biniou data
  • Optional fields and default values
  • Smooth protocol upgrades
    • Adding or removing an optional record field
    • Adding a required record field
    • Removing a required record field
    • Adding a variant case
    • Removing a variant case
    • Avoiding future problems
  • Data validation
  • Modularity: referring to type definitions from another ATD file
  • Managing JSON configuration files
  • Integration with ocamldoc
  • Integration with build systems
    • OMake
    • GNU Make
    • Ocamlbuild
    • Dune (formerly jbuilder)
  • Dealing with untypable JSON
• ATD core syntax reference
  • Introduction
    • Scope
    • Language overview
    • Editing and validating ATD files
  • ATD language
    • Notations
    • Lexical rules
    • Grammar
    • Predefined type names
    • abstract Type defined elsewhere
    • Shared values
  • See also
• Atdgen reference
  • Description
  • Command-line usage
    • Command-line help
    • Atdgen-json example
    • Atdgen-biniou example
    • Validator example
  • Default type mapping
  • ATD Annotations
    • Section json
    • Section biniou
    • Section ocaml
    • Section ocaml_biniou
    • Section ocaml_json (obsolete)
    • Section doc
  • Atdgen runtime library
• Java/Json support with atdj
  • Installation
  • Quick-start
  • Generating the interface
  • Generating Javadoc documentation
  • Generating a class graph
  • Translation reference
    • Bools, ints, floats, string, lists
    • Options
    • Records
    • Sums
    • The Atdj and Visitor interfaces