Added more docs around config

2026-04-15 19:30:49 -07:00 · 2020-11-01 06:29:49 +11:00
parent e572345068
commit b6dd999757
1 changed files with 23 additions and 7 deletions
--- a/config.go
+++ b/config.go
@@ -11,13 +11,29 @@ import (

 // AppConfig is the configuration structure used when creating a Wails App object
 type AppConfig struct {
-	Width, Height    int
-	Title            string
-	HTML             string
-	JS               string
-	CSS              string
-	Colour           string
-	Resizable        bool
+	// The width and height of your application in pixels
+	Width, Height int
+
+	// The title to put in the title bar
+	Title string
+
+	// The HTML your app should use. If you leave it blank, a default will be used:
+	// <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta http-equiv="IE=edge" content="IE=edge"></head><body><div id="app"></div><script type="text/javascript"></script></body></html>
+	HTML string
+
+	// The Javascript your app should use. Normally this should be generated by a bundler.
+	JS string
+
+	// The CSS your app should use. Normally this should be generated by a bundler.
+	CSS string
+
+	// The colour of your window. Can take "#fff", "rgb(255,255,255)", "rgba(255,255,255,1)" formats
+	Colour string
+
+	// Indicates whether your app should be resizable
+	Resizable bool
+
+	// Indicated if the devtools should be disabled
 	DisableInspector bool
 }