aboutsummaryrefslogtreecommitdiff
path: root/core/.browser.lua
diff options
context:
space:
mode:
authormitchell <70453897+667e-11@users.noreply.github.com>2009-07-25 23:34:13 -0400
committermitchell <70453897+667e-11@users.noreply.github.com>2009-07-25 23:34:13 -0400
commit033416a15fe60fe10387119e0e63bb9ed9e8aedd (patch)
tree31bc4d91e15b484c336eadf25c0008f7bd17facc /core/.browser.lua
parentb9e5e58446c95344b550c0a6ab91aa57ee9468ef (diff)
downloadtextadept-033416a15fe60fe10387119e0e63bb9ed9e8aedd.tar.gz
textadept-033416a15fe60fe10387119e0e63bb9ed9e8aedd.zip
Documentation overhaul.
Diffstat (limited to 'core/.browser.lua')
-rw-r--r--core/.browser.lua12
1 files changed, 4 insertions, 8 deletions
diff --git a/core/.browser.lua b/core/.browser.lua
index a9bb2ac1..486d9557 100644
--- a/core/.browser.lua
+++ b/core/.browser.lua
@@ -3,9 +3,6 @@
---
-- A model browser for the Textadept project manager.
--- It can be loaded by adding to the browsers table in core/ext/pm.lua or by
--- 'require'ing it elsewhere.
--- [Dummy file]
module('textadept.pm.browser')
---
@@ -40,8 +37,8 @@ function get_contents_for(full_path, expanding)
---
-- Performs an action based on the selected treeview item.
-- This function is called internally and shouldn't be called by a script.
--- @param selected_item Identical to 'full_path' in pm.get_contents_for.
--- @see pm.get_contents_for
+-- @param selected_item Identical to 'full_path' in get_contents_for.
+-- @see get_contents_for
function perform_action(selected_item)
---
@@ -54,15 +51,14 @@ function perform_action(selected_item)
-- 'gtk-*' - a stock menu item is created based on the GTK stock-id.
-- 'separator' - a menu separator item is created.
-- Otherwise a regular menu item with a mnemonic is created.
--- @see pm.get_contents_for
function get_context_menu(selected_item)
---
-- Performs an action based on the selected menu item.
-- This function is called internally and shouldn't be called by a script.
-- @param menu_id The numeric ID of the menu item.
--- @param selected_item Identical to 'full_path' in pm.get_contents_for.
--- @see pm.get_contents_for
+-- @param selected_item Identical to 'full_path' in get_contents_for.
+-- @see get_contents_for
function perform_menu_action(menu_id, selected_item)
---