update documentation

Goober5000 · Goober5000 · commit dfe34ec58d93 · 2024-09-11T02:03:40.000-04:00
diff --git a/code/scripting/api/objs/hudgauge.cpp b/code/scripting/api/objs/hudgauge.cpp
@@ -21,7 +21,7 @@ ADE_FUNC(isCustom, l_HudGauge, nullptr, "Custom HUD Gauge status", "boolean", "R
 	return ade_set_args(L, "b", gauge->isCustom());
 }
 
-ADE_VIRTVAR(Name, l_HudGauge, "string", "Custom HUD Gauge name", "string", "Custom HUD Gauge name, or blank if this is a default gauge, or nil if handle is invalid")
+ADE_VIRTVAR(Name, l_HudGauge, "string", "Custom HUD Gauge name", "string", "Custom HUD Gauge name, or nil if this is a default gauge or the handle is invalid")
 {
 	HudGauge* gauge;
 
@@ -37,7 +37,7 @@ ADE_VIRTVAR(Name, l_HudGauge, "string", "Custom HUD Gauge name", "string", "Cust
 	return ade_set_args(L, "s", gauge->getCustomGaugeName());
 }
 
-ADE_VIRTVAR(Text, l_HudGauge, "string", "Custom HUD Gauge text", "string", "Custom HUD Gauge text, or blank if this is a default gauge, or nil if handle is invalid")
+ADE_VIRTVAR(Text, l_HudGauge, "string", "Custom HUD Gauge text", "string", "Custom HUD Gauge text, or nil if this is a default gauge or the handle is invalid")
 {
 	HudGauge* gauge;
 	const char* text = nullptr;

Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ ADE_FUNC(isCustom, l_HudGauge, nullptr, "Custom HUD Gauge status", "boolean", "R`
`21`	`21`	`return ade_set_args(L, "b", gauge->isCustom());`
`22`	`22`	`}`
`23`	`23`
`24`		`-ADE_VIRTVAR(Name, l_HudGauge, "string", "Custom HUD Gauge name", "string", "Custom HUD Gauge name, or blank if this is a default gauge, or nil if handle is invalid")`
	`24`	`+ADE_VIRTVAR(Name, l_HudGauge, "string", "Custom HUD Gauge name", "string", "Custom HUD Gauge name, or nil if this is a default gauge or the handle is invalid")`
`25`	`25`	`{`
`26`	`26`	`HudGauge* gauge;`
`27`	`27`
`@@ -37,7 +37,7 @@ ADE_VIRTVAR(Name, l_HudGauge, "string", "Custom HUD Gauge name", "string", "Cust`
`37`	`37`	`return ade_set_args(L, "s", gauge->getCustomGaugeName());`
`38`	`38`	`}`
`39`	`39`
`40`		`-ADE_VIRTVAR(Text, l_HudGauge, "string", "Custom HUD Gauge text", "string", "Custom HUD Gauge text, or blank if this is a default gauge, or nil if handle is invalid")`
	`40`	`+ADE_VIRTVAR(Text, l_HudGauge, "string", "Custom HUD Gauge text", "string", "Custom HUD Gauge text, or nil if this is a default gauge or the handle is invalid")`
`41`	`41`	`{`
`42`	`42`	`HudGauge* gauge;`
`43`	`43`	`const char* text = nullptr;`