# README
getdoc
Documentation extract utilities for Telegram schema using goquery.
Used by gotd/td for embedding documentation to generated code.
Parsed documentation
Parsed documentation for 133 layer is available as 133.json with schema.
Example
Latest schema is embedded to package, so you can just use it:
doc, err := getdoc.Load(133)
if err != nil {
panic(err)
}
fmt.Printf("Layer %d, constructors: %d\n", doc.Index.Layer, len(doc.Constructors))
// Output:
// Layer 133, constructors: 926
Reference
Please use official documentation, it is for humans, this package is not.
# Functions
Extract uses Downloader to extract documentation.
ExtractLayer uses Downloader to extract documentation of specified layer.
LayerExists returns true if layer is included in package.
Load layer documentation.
ParseConstructor parses html documentation from reader and produces Constructor.
ParseIndex parses schema index documentation from reader.
ParseMethod extracts method documentation from reader.
ParseType parses Type documentation from reader.
# Constants
No description provided by the author
No description provided by the author
No description provided by the author
LayerLatest is id of the latest layer.
# Variables
ErrNotFound means that current package version does not support requested layer.
Layers is list of supported layers.
# Structs
Category index.
Constructor represents constructor documentation.
Doc represents full documentation description.
Error represent possible error documentation.
Index of schema.
Method represents method documentation.
No description provided by the author
Type represents type (aka class) documentation.
# Interfaces
Downloader abstracts documentation fetching.