VirtualMachine: Update docs for replaceReturnValue()

adazem009 · adazem009 · commit 13b2b78ed4db · 2023-08-09T00:10:17.000+02:00
diff --git a/src/engine/virtualmachine.cpp b/src/engine/virtualmachine.cpp
@@ -105,7 +105,13 @@ void VirtualMachine::addReturnValue(const Value &v)
     *impl->regs[impl->regCount++] = v;
 }
 
-/*! Replaces the given register (last register minus offset). */
+/*!
+ * Replaces the given register. For example:
+ * \code
+ * replaceReturnValue("...", 1) // write to last register
+ * replaceReturnValue("...", 2) // write to second last register
+ * \endcode
+ */
 void VirtualMachine::replaceReturnValue(const Value &v, unsigned int offset)
 {
     *impl->regs[impl->regCount - offset] = v;

Original file line number	Diff line number	Diff line change
`@@ -105,7 +105,13 @@ void VirtualMachine::addReturnValue(const Value &v)`
`105`	`105`	`*impl->regs[impl->regCount++] = v;`
`106`	`106`	`}`
`107`	`107`
`108`		`-/! Replaces the given register (last register minus offset). /`
	`108`	`+/*!`
	`109`	`+ * Replaces the given register. For example:`
	`110`	`+ * \code`
	`111`	`+ * replaceReturnValue("...", 1) // write to last register`
	`112`	`+ * replaceReturnValue("...", 2) // write to second last register`
	`113`	`+ * \endcode`
	`114`	`+ */`
`109`	`115`	`void VirtualMachine::replaceReturnValue(const Value &v, unsigned int offset)`
`110`	`116`	`{`
`111`	`117`	`*impl->regs[impl->regCount - offset] = v;`