From 414e227a1a723ab2bd7c4e8c99649fe9146a9bed Mon Sep 17 00:00:00 2001
From: Julien Danjou <julien@danjou.info>
Date: Wed, 2 Jul 2008 10:32:35 +0200
Subject: [PATCH] build: add support for documentation of __index

Signed-off-by: Julien Danjou <julien@danjou.info>
---
 build-utils/fake-lua-src.lua | 44 +++++++++++++++++++++++-------------
 1 file changed, 28 insertions(+), 16 deletions(-)

diff --git a/build-utils/fake-lua-src.lua b/build-utils/fake-lua-src.lua
index 135459a1..a8742e95 100755
--- a/build-utils/fake-lua-src.lua
+++ b/build-utils/fake-lua-src.lua
@@ -10,16 +10,19 @@ function string.replace_param(s)
 end
 
 function string.comment_translate(s)
-	local lua_comment = "";
-        nparam = 0;
-	for line in s:gmatch("[^\r\n]+") do
-		line = line:gsub("/%*%*", "---")
-		line = line:gsub("^.*%*", "--")
-		line = line:gsub("\\lvalue", "")
-		line = line:gsub("\\(lparam)", string.replace_param)
-		line = line:gsub("\\lreturn", "@return")
-		lua_comment = lua_comment .. line .. "\n"
-	end
+    local lua_comment = "";
+    nparam = 0;
+    for line in s:gmatch("[^\r\n]+") do
+            line = line:gsub("/%*%*", "---")
+            line = line:gsub("^.*%*", "--")
+            line = line:gsub("\\lvalue", "")
+            line = line:gsub("\\(lparam)", string.replace_param)
+            line = line:gsub("\\lreturn", "@return")
+            line = line:gsub("\\lfield", "@field")
+            lua_comment = lua_comment .. line .. "\n"
+    end
+    -- remove last \n
+    lua_comment = lua_comment:sub(1, #lua_comment - 1)
     return lua_comment
 end
 
@@ -70,13 +73,22 @@ for i, line in ipairs(ilines) do
         else
             local fctname, fctdef
             _, _, fctname, fctdef = line:find("\"(.+)\", (.+) },?")
-            if fctname and (not fctname:find("^__") or fctname:find("^__call")) then
+            if fctname and (not fctname:find("^__")
+                            or fctname:find("^__call")
+                            or fctname:find("^__index")) then
                 if function_doc[fctdef] then
-                    fctname = "." .. fctname
-                    fctname = fctname:gsub("^.__call", "")
-                    print(function_doc[fctdef]:comment_translate())
-                    print("function " .. libname .. fctname .. "()")
-                    print("end");
+                    if fctname:find("^__index") then
+                        print(function_doc[fctdef]:comment_translate())
+                        print("-- @class table")
+                        print("-- @name " .. libname)
+                        print(libname)
+                    else
+                        fctname = "." .. fctname
+                        fctname = fctname:gsub("^.__call", "")
+                        print(function_doc[fctdef]:comment_translate())
+                        print("function " .. libname .. fctname .. "()")
+                        print("end");
+                    end
                 else
                     print("This function is not yet documented.")
                 end