vis-lua: add usage documentation to command_register

1 files changed, 10 insertions, 1 deletions

diff --git a/vis-lua.c b/vis-lua.c
index 4810d7f..509a84e 100644
--- a/vis-lua.c
+++ b/vis-lua.c
@@ -1142,7 +1142,16 @@ static bool command_lua(Vis *vis, Win *win, void *data, bool force, const char *
  * @tparam[opt] string help the single line help text as displayed in `:help`
  * @treturn bool whether the command has been successfully registered
  * @usage
- * TODO
+ * vis:command_register("foo", function(argv, force, win, cursor, range)
+ * 	 for i,arg in ipairs(argv) do
+ * 		 print(i..": "..arg)
+ * 	 end
+ * 	 print("was command forced with ! "..(force and "yes" or "no"))
+ * 	 print(win.file.name)
+ * 	 print(cursor.pos)
+ * 	 print(range ~= nil and ('['..range.start..', '..range.finish..']') or "invalid range")
+ * 	 return true;
+ * end)
  */
 static int command_register(lua_State *L) {
 	Vis *vis = obj_ref_check(L, 1, "vis");