vis

a vi-like editor based on Plan 9's structural regular expressions
README.md

(1206B)
      1 This is the destination directory for the LDoc documentation of Vis' Lua API
      2 as generated by the `make luadoc`.
      3 
      4 Unfortunately `ldoc(1)` seems to have a bug which generates broken reference
      5 links for custom types. The following patch seems to fix the issue:
      6 
      7 ```
      8 From 96a1fbc8e972fedf665049a6351f46bc1aac1768 Mon Sep 17 00:00:00 2001
      9 From: =?UTF-8?q?Marc=20Andr=C3=A9=20Tanner?= <mat@brain-dump.org>
     10 Date: Tue, 6 Dec 2016 15:59:17 +0100
     11 Subject: [PATCH] Fix references to class types.
     12 
     13 For classes the generated HTML anchors need to be prefixed 'Class_'.
     14 ---
     15  ldoc/doc.lua | 6 +++---
     16  1 file changed, 3 insertions(+), 3 deletions(-)
     17 
     18 diff --git a/ldoc/doc.lua b/ldoc/doc.lua
     19 index e19b2df..f368b90 100644
     20 --- a/ldoc/doc.lua
     21 +++ b/ldoc/doc.lua
     22 @@ -1073,9 +1073,9 @@ end
     23  local function reference (s, mod_ref, item_ref)
     24     local name = item_ref and item_ref.name or ''
     25     -- this is deeply hacky; classes have 'Class ' prepended.
     26 ---~    if item_ref and doc.class_tag(item_ref.type) then
     27 ---~       name = 'Class_'..name
     28 ---~    end
     29 +       if item_ref and doc.class_tag(item_ref.type) then
     30 +          name = 'Class_'..name
     31 +       end
     32     return {mod = mod_ref, name = name, label=s}
     33  end
     34  
     35 -- 
     36 1.9.1
     37 ```