Merge pull request #42 from maxiestudies/main

Add example of a member that shouldn't get documented
projectdiscovery · Jan 31, 2025 · 0a7ac4c · 0a7ac4c
2 parents a450166 + 5647ff2
commit 0a7ac4c
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/examples/types.go b/examples/types.go
@@ -59,6 +59,9 @@ type Job struct {
 	//   - name: InternalOptions Example
 	//     value: exampleInternalOptions
 	InternalOptions *InternalOptions `yaml:"internal-options" json:"internal-options"`
+	// docgen:nodoc
+	// you can also skip members that are not part of the yaml file
+	NotConfiguredByYaml string
 }
 
 // InternalOptions contains internal configuration options for scheduler