From 44d46d022675756783e3c007923a77446d52b7e7 Mon Sep 17 00:00:00 2001
From: mitchell <70453897+667e-11@users.noreply.github.com>
Date: Thu, 17 Jun 2010 21:40:46 -0400
Subject: Renamed core/.*.lua to core/.*.luadoc documentation files.

---
 core/.command_entry.luadoc | 42 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)
 create mode 100644 core/.command_entry.luadoc

(limited to 'core/.command_entry.luadoc')

diff --git a/core/.command_entry.luadoc b/core/.command_entry.luadoc
new file mode 100644
index 00000000..93615f22
--- /dev/null
+++ b/core/.command_entry.luadoc
@@ -0,0 +1,42 @@
+-- Copyright 2007-2010 Mitchell mitchell<att>caladbolg.net. See LICENSE.
+-- This is a DUMMY FILE used for making LuaDoc for built-in functions in the
+-- global gui.command_entry table.
+
+---
+-- Textadept's Command entry.
+module('gui.command_entry')
+
+-- Markdown:
+-- ## Fields
+--
+-- * `entry_text`: The text in the entry.
+--
+-- ## Overview
+--
+-- Access to the Lua state is available through this command entry. It is useful
+-- for debugging, inspecting, and entering buffer or view commands. If you try
+-- cause instability in Textadept's Lua state, you might very well succeed. Be
+-- careful.
+--
+-- Tab-completion for functions, variables, tables, etc. is available. Press the
+-- `Tab` key to display a list of available completions. Use the arrow keys to
+-- make a selection and press `Enter` to insert it.
+--
+-- Abbreviated commands for the `buffer`, `view` and `gui` are available. So
+-- `buffer:append_text('textadept')` can be shortened to
+-- `append_text('textadept')`. Please note `print()` calls
+-- [`gui.print()`][gui_print] and not Lua's `print()`. The latter can be
+-- accessed with `_G.print()`.
+--
+-- [gui_print]: ../modules/gui.html#print
+--
+-- ## Extending
+--
+-- You can extend the command entry to do more than enter Lua commands. An
+-- example of this is [incremental search][inc_search]. See
+-- `modules/textadept/find.lua` for the implementation.
+--
+-- [inc_search]: ../modules/gui.find.html#incremental
+
+--- Focuses the command entry.
+function focus() end
-- 
cgit v1.2.3