Home | History | Annotate | Download | only in source
      1 Go API
      2 ======
      3 
      4 \addtogroup flatbuffers_go_api
      5 
      6 <!-- Note: The `GoApi_generate.txt` code snippet was generated using `godoc` and
      7      customized for use with this markdown file. To regenerate the file, use the
      8      `godoc` tool (http://godoc.org) with the files in the `flatbuffers/go`
      9      folder.
     10 
     11      You may need to ensure that copies of the files exist in the `src/`
     12      subfolder at the path set by the `$GOROOT` environment variable. You can
     13      either move the files to `$GOROOT/src/flatbuffers` manually, if `$GOROOT`
     14      is already set, otherwise you will need to manually set the `$GOROOT`
     15      variable to a path and create `src/flatbuffers` subfolders at that path.
     16      Then copy the flatbuffers files into `$GOROOT/src/flatbuffers`. (Some
     17      versions of `godoc` include a `-path` flag. This could be used instead, if
     18      available).
     19 
     20      Once the files exist at the `$GOROOT/src/flatbuffers` location, you can
     21      regenerate this doc using the following command:
     22      `godoc flatbuffers > GoApi_generated.txt`.
     23 
     24      After the documentation is generated, you will have to manually remove any
     25      non-user facing documentation from this file. -->
     26 \snippet GoApi_generated.txt Go API
     27