Browse Source

Use 'class_notes' tag to indicate non-gc'd classes in generated Lua documentation.

Christopher Reed 12 years ago
parent
commit
8b39189581
1 changed files with 3 additions and 0 deletions
  1. 3 0
      Bindings/Scripts/create_lua_library/create_lua_library.py

+ 3 - 0
Bindings/Scripts/create_lua_library/create_lua_library.py

@@ -208,6 +208,9 @@ def createLUABindings(inputPath, prefix, mainInclude, libSmallName, libName, api
 				if 'doxygen' in c:
 					luaDocOut += "\t\t<desc><![CDATA[%s]]></desc>\n" % (cleanDocs(c['doxygen']))
 
+				if ckey in disable_gc:
+					luaDocOut += "\t\t<class_notes>NOTE: %s instances are not automatically garbage collected.</class_notes>\n" % (ckey)
+				
 				parsed_methods = [] # Def: List of discovered methods
 				ignore_methods = ["readByte32", "readByte16", "getCustomEntitiesByType", "Core", "Renderer", "Shader", "Texture", "handleEvent", "secondaryHandler", "getSTLString", "readInt"]
 				luaClassBindingOut += "\n\n"