From 033416a15fe60fe10387119e0e63bb9ed9e8aedd Mon Sep 17 00:00:00 2001
From: mitchell <70453897+667e-11@users.noreply.github.com>
Date: Sat, 25 Jul 2009 23:34:13 -0400
Subject: Documentation overhaul.

---
 modules/textadept/bookmarks.lua | 21 ++++++++++++++-------
 1 file changed, 14 insertions(+), 7 deletions(-)

(limited to 'modules/textadept/bookmarks.lua')

diff --git a/modules/textadept/bookmarks.lua b/modules/textadept/bookmarks.lua
index 3fdca987..a94c56db 100644
--- a/modules/textadept/bookmarks.lua
+++ b/modules/textadept/bookmarks.lua
@@ -5,15 +5,22 @@ local locale = _G.locale
 
 ---
 -- Bookmarks for the textadept module.
--- There are several option variables used:
---   MARK_BOOKMARK: The integer mark used to identify a bookmarked line.
---   MARK_BOOKMARK_COLOR: The Scintilla color used for a bookmarked line.
 module('_m.textadept.bookmarks', package.seeall)
 
--- options
-local MARK_BOOKMARK = 1
-local MARK_BOOKMARK_COLOR = 0xC08040
--- end options
+-- Markdown:
+-- ## Settings
+--
+-- * `MARK_BOOKMARK`: The unique integer mark used to identify a bookmarked
+--    line.
+-- * `MARK_BOOKMARK_COLOR`: The [Scintilla color][scintilla_color] used for a
+--    bookmarked line.
+--
+-- [scintilla_color]: http://scintilla.org/ScintillaDoc.html#colour
+
+-- settings
+MARK_BOOKMARK = 1
+MARK_BOOKMARK_COLOR = 0xC08040
+-- end settings
 
 ---
 -- Adds a bookmark to the current line.
-- 
cgit v1.2.3