Additional package comments.

master
Matthieu Lalonde 5 years ago
parent 8c4ced0ac5
commit 8e49a73a63

@ -1,3 +1,5 @@
// Package altvr contains functions used to
// interface with the AltspaceVR API
package altvr package altvr
import ( import (
@ -7,7 +9,7 @@ import (
"golang.org/x/net/publicsuffix" "golang.org/x/net/publicsuffix"
) )
// AltVR Client Type // AltVR Is the main ASVR client type
type AltVR struct { type AltVR struct {
jar *cookiejar.Jar jar *cookiejar.Jar
username string username string

@ -186,7 +186,7 @@ func (u *User) GetDisplayName() string {
// Identity json struct // Identity json struct
// https://account.altvr.com/api/users/identity.json // https://account.altvr.com/api/users/identity.json
// DO NOT USE!! // DO NOT USE!! Requires Auth Token
type Identity struct { type Identity struct {
Users []User `json:"users"` Users []User `json:"users"`
Settings struct { Settings struct {

@ -1,3 +1,6 @@
// Package bot is the main AltspaceVR Bot
// It initializes the ASVR Client API, the discord bot
// and handles all requests from the bot.
package bot package bot
import ( import (

@ -1,3 +1,5 @@
// Package discord contains the interface functions
// to for the discordgo library
package discord package discord
import ( import (

@ -1,3 +1,4 @@
// Package utils contains various utility functions
package utils package utils
import ( import (

Loading…
Cancel
Save