chore: add docs for WithEngineOptions and NewEngine

engine.go

@@ -9,6 +9,18 @@ import (
 	"path/filepath"
 )
 
+// NewEngine creates a new Engine with the given options.
+// For example:
+//
+//	engine := fuego.NewEngin(
+//		WithOpenAPIConfig(
+//			OpenAPIConfig{
+//				PrettyFormatJSON: true,
+//			},
+//		),
+//	)
+//
+// Options all begin with `With`.
 func NewEngine(options ...func(*Engine)) *Engine {
 	e := &Engine{
 		OpenAPI:       NewOpenAPI(),

server.go

@@ -89,7 +89,7 @@ type Server struct {
 //		fuego.WithoutLogger(),
 //	)
 //
-// Option all begin with `With`.
+// Options all begin with `With`.
 // Some default options are set in the function body.
 func NewServer(options ...func(*Server)) *Server {
 	s := &Server{
@@ -397,6 +397,20 @@ func WithOpenAPIServerConfig(config OpenAPIServerConfig) func(*Server) {
 	}
 }
 
+// WithEngineOptions allows for setting of Engine options
+//
+//	app := fuego.NewServer(
+//		fuego.WithAddr(":8080"),
+//		fuego.WithEngineOptions(
+//			WithOpenAPIConfig(
+//				OpenAPIConfig{
+//					PrettyFormatJSON: true,
+//				},
+//			),
+//		),
+//	)
+//
+// Options all begin with `With`.
 func WithEngineOptions(options ...func(*Engine)) func(*Server) {
 	return func(s *Server) {
 		for _, option := range options {

server_test.go

@@ -90,12 +90,13 @@ func TestWithOpenAPIConfig(t *testing.T) {
 				SpecURL:    "/api/openapi.json",
 			}),
 			WithEngineOptions(
-				WithOpenAPIConfig(OpenAPIConfig{
-					JSONFilePath:     "openapi.json",
-					DisableLocalSave: true,
-					PrettyFormatJSON: true,
-					Disabled:         true,
-				}),
+				WithOpenAPIConfig(
+					OpenAPIConfig{
+						JSONFilePath:     "openapi.json",
+						DisableLocalSave: true,
+						PrettyFormatJSON: true,
+						Disabled:         true,
+					}),
 			),
 		)