Update remaining scripts to use long-comment documentation

adv-max-skills.lua

@@ -1,12 +1,12 @@
 -- Maximizes adventurer skills/attributes on creation
---[[=begin
+--[====[
 
 adv-max-skills
 ==============
 When creating an adventurer, raises all changeable skills and
 attributes to their maximum level.
 
-=end]]
+]====]
 if dfhack.gui.getCurFocus() ~= 'setupadventure' then
     qerror('Must be called on adventure mode setup screen')
 end

combine-drinks.lua

@@ -1,11 +1,11 @@
 -- Merge drink stacks in the selected stockpile
---[[=begin
+--[====[
 
 combine-drinks
 ==============
 Merge stacks of drinks in the selected stockpile.
 
-=end]]
+]====]
 local utils = require 'utils'
 
 validArgs = validArgs or utils.invert({ 'max', 'stockpile' })

combine-plants.lua

@@ -1,11 +1,11 @@
 -- Merge plant stacks in the selected container or stockpile
---[[=begin
+--[====[
 
 combine-plants
 ==============
 Merge stacks of plants or plant growths in the selected container or stockpile.
 
-=end]]
+]====]
 local utils = require 'utils'
 
 validArgs = validArgs or utils.invert({ 'max', 'stockpile', 'container' })

devel/annc-monitor.lua

@@ -1,6 +1,6 @@
 -- Displays announcements in the DFHack console
 --@ enable = true
---[[=begin
+--[====[
 
 devel/annc-monitor
 ==================
@@ -11,7 +11,7 @@ Displays announcements and reports in the console.
 :interval X:        Sets the delay between checks for
                     new announcements to ``X`` frames
 
-=end]]
+]====]
 
 VERSION = '0.2'
 

devel/click-monitor.lua

@@ -1,6 +1,6 @@
 -- Displays the mouse (grid) coordinates when the mouse is clicked
 --@ enable = true
---[[=begin
+--[====[
 
 devel/click-monitor
 ===================
@@ -9,7 +9,7 @@ Useful for plugin/script development.
 
 Usage: ``devel/click-monitor start|stop``
 
-=end]]
+]====]
 
 VERSION = '0.2'
 

devel/modstate-monitor.lua

@@ -1,6 +1,6 @@
 -- Displays changes in the key modifier state
 --@ enable = true
---[[=begin
+--[====[
 
 devel/modstate-monitor
 ======================
@@ -9,7 +9,7 @@ Display changes in key modifier state, ie Ctrl/Alt/Shift.
 :enable|start:  Begin monitoring
 :disable|stop:  End monitoring
 
-=end]]
+]====]
 
 VERSION = '0.1'
 

embark-skills.lua

@@ -1,5 +1,5 @@
 -- Adjusts dwarves' skills when embarking
---[[=begin
+--[====[
 
 embark-skills
 =============
@@ -14,7 +14,7 @@ Note that already-used skill points are not taken into account or reset.
 :legendary:     Sets all skills of the selected dwarf to "Legendary".
 :legendary all: Sets all skills of all dwarves to "Legendary".
 
-=end]]
+]====]
 
 VERSION = '0.1'
 

gui/extended-status.lua

@@ -1,6 +1,6 @@
 -- Adds more z-status subpages
 --@ enable = true
---[[=begin
+--[====[
 
 gui/extended-status
 ===================
@@ -11,7 +11,7 @@ Usage::
     gui/extended-status enable|disable|help|subpage_names
     enable|disable gui/extended-status
 
-=end]]
+]====]
 
 gui = require 'gui'
 dialogs = require 'gui.dialogs'

gui/load-screen.lua

@@ -1,14 +1,14 @@
 -- A replacement for the "load game" screen
 --@ enable = true
---[[=begin
+--[====[
 
 gui/load-screen
 ===============
 A replacement for the "continue game" screen.
 
 Usage: ``gui/load-screen enable|disable``
 
-=end]]
+]====]
 
 VERSION = '0.8.4'
 

gui/quickcmd.lua

@@ -1,13 +1,13 @@
 --- Simple menu to quickly execute common commands.
---[[=begin
+--[====[
 
 gui/quickcmd
 ============
 A list of commands which you can edit while in-game, and which you can execute
 quickly and easily. For stuff you use often enough to not want to type it, but
 not often enough to be bothered to find a free keybinding.
 
-=end]]
+]====]
 
 --[[
 Copyright (c) 2014, Michon van Dooren

gui/settings-manager.lua

@@ -1,5 +1,5 @@
 -- An in-game init file editor
---[[=begin
+--[====[
 
 gui/settings-manager
 ====================
@@ -10,7 +10,7 @@ Recommended for use as a keybinding::
     keybinding add Alt-S@title settings-manager
     keybinding add Alt-S@dwarfmode/Default settings-manager
 
-=end]]
+]====]
 
 VERSION = '0.6.0'
 

launch.lua

@@ -1,13 +1,13 @@
 -- Launch unit to cursor location
 -- Based on propel.lua by Roses, molested by Rumrusher and I until this happened, sorry.
---[[=begin
+--[====[
 
 launch
 ======
 Activate with a cursor on screen and you will go there rapidly, attack
 something first to send them there.
 
-=end]]
+]====]
 function launch(unitSource,unitTarget)
   local curpos
   if df.global.ui_advmode.menu==1 then

modtools/raw-lint.lua

@@ -1,12 +1,12 @@
 -- Check for common mistakes in raw files
 --@ enable = true
---[[=begin
+--[====[
 
 modtools/raw-lint
 =================
 Checks for simple issues with raw files. Can be run automatically.
 
-=end]]
+]====]
 
 utils = require 'utils'
 

names.lua

@@ -1,5 +1,5 @@
 --rename items or units
---[[=begin
+--[====[
 
 names
 =====
@@ -10,7 +10,7 @@ Rename units or items.  Usage:
 :-unit:     if viewing a unit
 :-first [Somename | "Some Names like This":
             if a first name is desired, leave blank to clear current first name
-=end]]
+]====]
 local utils = require 'utils'
 
 validArgs = validArgs or utils.invert({

open-legends.lua

@@ -1,13 +1,13 @@
 -- open legends screen when in fortress mode
 --@ module = true
---[[=begin
+--[====[
 
 open-legends
 ============
 Open a legends screen when in fortress mode.
 Compatible with `exportlegends`.
 
-=end]]
+]====]
 
 gui = require 'gui'
 utils = require 'utils'

prefchange.lua

@@ -4,7 +4,7 @@
 -- updated with print all and clear all functions on the 11th of April 2015
 -- Praise Armok!
 
---[[=begin
+--[====[
 
 prefchange
 ==========
@@ -30,7 +30,7 @@ Valid options:
 Feel free to adjust the values as you see fit, change the has steel to
 platinum, change the axp axes to great axes, whatnot.
 
-=end]]
+]====]
 -- ---------------------------------------------------------------------------
 function axeplate(unit)
     local unit = dfhack.gui.getSelectedUnit()

troubleshoot-item.lua

@@ -1,12 +1,12 @@
 -- troubleshoot-item.lua
 --@ module = true
---[[=begin
+--[====[
 
 troubleshoot-item
 =================
 Print various properties of the selected item.
 
-=end]]
+]====]
 
 function find_specific_ref(object, type)
     for i, ref in pairs(object.specific_refs) do