Update BangBangElement KDoc

rowan-mcalpin · rowan-mcalpin · commit a5e6d9064cd9 · 2025-03-25T12:48:59.000-07:00
diff --git a/nextcontrol/src/main/kotlin/dev/nextftc/nextcontrol/feedback/BangBangElement.kt b/nextcontrol/src/main/kotlin/dev/nextftc/nextcontrol/feedback/BangBangElement.kt
@@ -37,7 +37,7 @@ data class BangBangParameters @JvmOverloads constructor(
  *  -1, when error is 0, output 0.
  *
  * @param feedbackType The type of component this controller operates on
- * @param gain the constant that the output is multiplied by
+ * @param parameters the [BangBangParameters] for this element
  *
  * @author rowan-mcalpin
  */

Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ data class BangBangParameters @JvmOverloads constructor(`
`37`	`37`	`* -1, when error is 0, output 0.`
`38`	`38`	`*`
`39`	`39`	`* @param feedbackType The type of component this controller operates on`
`40`		`- * @param gain the constant that the output is multiplied by`
	`40`	`+ * @param parameters the [BangBangParameters] for this element`
`41`	`41`	`*`
`42`	`42`	`* @author rowan-mcalpin`
`43`	`43`	`*/`