From f90d5e1f07fdc9dea7c24b11107049b613a5be7a Mon Sep 17 00:00:00 2001
From: Albert Cervin <albert@acervin.com>
Date: Sun, 29 Jan 2023 22:22:54 +0100
Subject: More tests and documentation

Also improve find file and switch buffer a bit.

Implement word backward/forward.
---
 src/minibuffer.h | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 53 insertions(+)

(limited to 'src/minibuffer.h')

diff --git a/src/minibuffer.h b/src/minibuffer.h
index ec24f49..71885ec 100644
--- a/src/minibuffer.h
+++ b/src/minibuffer.h
@@ -6,14 +6,67 @@
 struct buffer;
 struct command_ctx;
 
+/**
+ * Initialize the minibuffer.
+ *
+ * Note that the minibuffer is a global instance and this function will do
+ * nothing if called more than once.
+ * @param buffer underlying buffer to use for text IO in the minibuffer.
+ */
 void minibuffer_init(struct buffer *buffer);
 
+/**
+ * Echo a message to the minibuffer.
+ *
+ * @param fmt Format string for the message.
+ * @param ... Format arguments.
+ */
 void minibuffer_echo(const char *fmt, ...);
+
+/**
+ * Echo a message to the minibuffer that disappears after @ref timeout.
+ *
+ * @param timeout The timeout in seconds after which the message should
+ * disappear.
+ * @param fmt Format string for the message.
+ * @param ... Format arguments.
+ */
 void minibuffer_echo_timeout(uint32_t timeout, const char *fmt, ...);
 
+/**
+ * Prompt for user input in the minibuffer.
+ *
+ * This will move focus to the minibuffer and wait for user input, with the
+ * given prompt.
+ * @param command_ctx The command context to use to re-execute the calling
+ * command (or other command) when the user confirms the input.
+ * @param fmt Format string for the prompt.
+ * @param ... Format arguments.
+ */
 void minibuffer_prompt(struct command_ctx command_ctx, const char *fmt, ...);
+
+/**
+ * Abort the current minibuffer prompt.
+ *
+ * This returns focus to the previously focused window.
+ */
 void minibuffer_abort_prompt();
 
+/**
+ * Clear the current text in the minibuffer.
+ */
 void minibuffer_clear();
+
+/**
+ * Is the minibuffer currently displaying something?
+ *
+ * @returns True if the minibuffer is displaying anything, false otherwise.
+ */
 bool minibuffer_displaying();
+
+/**
+ * Is the minibuffer currently focused?
+ *
+ * @returns True if the minibuffer is currently focused, receiving user input.
+ */
 bool minibuffer_focused();
-- 
cgit v1.2.3