From 86a3fde07e7c0ac9478d2c10577f9d4d3acfde92 Mon Sep 17 00:00:00 2001
From: steve donovan <steve.j.donovan@gmail.com>
Date: Sun, 5 Jan 2014 14:55:20 +0200
Subject: [PATCH] issue #139; improved lookup for class methods; args override
 now only kicks if the argument does not have its default value

---
 ldoc.lua     | 16 ++++++++++------
 ldoc/doc.lua | 33 ++++++++++++++++++++++-----------
 2 files changed, 32 insertions(+), 17 deletions(-)

diff --git a/ldoc.lua b/ldoc.lua
index 9ae13e8..5aa3b6c 100644
--- a/ldoc.lua
+++ b/ldoc.lua
@@ -134,8 +134,10 @@ local add_language_extension
 -- hacky way for doc module to be passed options...
 doc.ldoc = ldoc
 
-local function override (field)
-   if args[field] == nil and ldoc[field] ~= nil then args[field] = ldoc[field] end
+-- if the corresponding argument was the default, then any ldoc field overrides
+local function override (field,defval)
+   defval = defval or false
+   if args[field] == defval and ldoc[field] ~= nil then args[field] = ldoc[field] end
 end
 
 -- aliases to existing tags can be defined. E.g. just 'p' for 'param'
@@ -336,6 +338,8 @@ source_dir = source_dir:gsub('[/\\]%.$','')
 --  * 'NAME' explicitly give the base module package name
 --
 
+override ('package','.')
+
 local function setup_package_base()
    if ldoc.package then args.package = ldoc.package end
    if args.package == '.' then
@@ -460,7 +464,7 @@ end
 
 -- create the function that renders text (descriptions and summaries)
 -- (this also will initialize the code prettifier used)
-override 'format'
+override ('format','plain')
 override 'pretty'
 ldoc.markup = markup.create(ldoc, args.format,args.pretty)
 
@@ -611,9 +615,9 @@ if args.filter ~= 'none' then
 end
 
 -- can specify format, output, dir and ext in config.ld
-override 'output'
-override 'dir'
-override 'ext'
+override ('output','index')
+override ('dir','doc')
+override ('ext','html')
 override 'one'
 
 -- handling styling and templates --
diff --git a/ldoc/doc.lua b/ldoc/doc.lua
index 7be979f..ef8aa31 100644
--- a/ldoc/doc.lua
+++ b/ldoc/doc.lua
@@ -219,6 +219,7 @@ function File:finish()
    local this_mod
    local items = self.items
    local tagged_inside
+   self.args = self.args or {}
    for item in items:iter() do
       if mod_section_type(this_mod) == 'factory' and item.tags then
          local klass = '@{'..this_mod.section.name..'}'
@@ -277,18 +278,21 @@ function File:finish()
             this_mod.section = nil
          else
             local summary = item.summary:gsub('%.$','')
+            local lookup_name
             if doc.class_tag(item.type) then
                display_name = 'Class '..item.name
+               lookup_name = item.name
                item.module = this_mod
                this_mod.items.by_name[item.name] = item
             else
                display_name = summary
+               lookup_name = summary
             end
             item.display_name = display_name
             this_mod.section = item
             this_mod.kinds:add_kind(display_name,display_name..' ',nil,item)
             this_mod.sections:append(item)
-            this_mod.sections.by_name[display_name:gsub('%A','_')] = item
+            this_mod.sections.by_name[lookup_name:gsub('%A','_')] = item
          end
       else
          local to_be_removed
@@ -1049,20 +1053,21 @@ end
 local function reference (s, mod_ref, item_ref)
    local name = item_ref and item_ref.name or ''
    -- this is deeply hacky; classes have 'Class ' prepended.
-   if item_ref and doc.class_tag(item_ref.type) then
-      name = 'Class_'..name
-   end
+--~    if item_ref and doc.class_tag(item_ref.type) then
+--~       name = 'Class_'..name
+--~    end
    return {mod = mod_ref, name = name, label=s}
 end
 
 function Module:lookup_class_item (packmod, s)
-   local section = "Class_"..packmod
-   if self.sections.by_name[section] then
-      for item in self.items:iter() do
-         --print('item',item.name,item.section)
-         if item.section == section and s == item.name then
-            return reference(s,self,item)
-         end
+   local klass = packmod --"Class_"..packmod
+   local qs = klass..':'..s
+   local klass_section = self.sections.by_name[klass]
+   if not klass_section then return nil end -- no such class
+   for item in self.items:iter() do
+      --print('item',qs,item.name)
+      if s == item.name or qs == item.name then
+         return reference(s,self,item)
       end
    end
    return nil
@@ -1114,6 +1119,12 @@ function Module:process_see_reference (s,modules,istype)
          if not mod_ref then
             local ref = self:lookup_class_item(packmod,s)
             if ref then return ref end
+            local mod, klass = split_dotted_name(packmod)
+            mod_ref = modules.by_name[mod]
+            if mod_ref then
+               ref = mod_ref:lookup_class_item(klass,name)
+               if ref then return ref end
+            end
             ref = lua_manual_ref(s)
             if ref then return ref end
             return nil,"module not found: "..packmod