{"id":13772870,"url":"https://keplerproject.github.io/luadoc/","last_synced_at":"2025-05-11T05:33:50.247Z","repository":{"id":1218818,"uuid":"1135874","full_name":"keplerproject/luadoc","owner":"keplerproject","description":"LuaDoc is obsolete, use LDoc instead →","archived":true,"fork":false,"pushed_at":"2016-01-06T12:31:44.000Z","size":426,"stargazers_count":84,"open_issues_count":1,"forks_count":26,"subscribers_count":11,"default_branch":"master","last_synced_at":"2024-08-03T17:10:25.466Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://github.com/stevedonovan/LDoc","language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/keplerproject.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2010-12-03T17:47:44.000Z","updated_at":"2024-06-09T16:07:43.000Z","dependencies_parsed_at":"2022-07-06T12:39:58.493Z","dependency_job_id":null,"html_url":"https://github.com/keplerproject/luadoc","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/keplerproject%2Fluadoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/keplerproject%2Fluadoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/keplerproject%2Fluadoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/keplerproject%2Fluadoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/keplerproject","download_url":"https://codeload.github.com/keplerproject/luadoc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225017623,"owners_count":17407805,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-03T17:01:08.652Z","updated_at":"2024-11-17T08:30:33.376Z","avatar_url":"https://github.com/keplerproject.png","language":"Lua","funding_links":[],"categories":["Documentation"],"sub_categories":[],"readme":"**LuaDoc is obsolete, use [LDoc](https://github.com/stevedonovan/LDoc) instead.**\n\nLuaDoc, version 3.0  \nTomas Guisasola (tomas@tecgraf.puc-rio.br)  \nhttp://luadoc.luaforge.net  \n13/aug/2007\n\n# What is it?\n\nLuaDoc is a documentation generator tool for Lua source code.\nIt parses the declarations and documentation comments in a set of Lua\nsource files and produces a set of XHTML pages describing the commented\ndeclarations and functions.\n\nThe output is not limited to XHTML. Other formats can be generated by\nimplementing new doclets. The format of the documentation comments is\nalso flexible and can be customized by implementing new taglets.\nPlease refer to customizing section for further information.\n\nLuaDoc is free software and uses the same license as Lua. \n\n# Distribution:\n\nThis distribution includes a set of  Lua  files  and  this  README.  It\nrequires Lua 5.1.\n\n# Installation:\n\nLuaDoc tool is composed by two parts, a library, and a launcher script.\n\nThe library follows the package model for Lua 5.1, therefore it should\nbe \"installed\".\n\nThe launcher script, namely luadoc.lua for Unix and luadoc.bat for Windows,\nshould be installed in your system PATH, so that it can be executed.\n\nLuaDoc also depends on two external packages: LuaFileSystem and LuaLogging,\nand you'll need to install them accordingly.\n\nOn Unix boxes, the file luadoc.lua could be used as a script;\nit's the same as:\n\n    lua5.1 luadoc.lua [options|files]\n\nThis is the main script: it will load LuaDoc library and process the\nspecified files. Try luadoc.lua --help, it will show you all available\noptions. \n\n# How does it work?\n\nLuaDoc works in two phases: analysis and synthesis.  On the first  one,\nall input files are analyzed and an intermediate structure is made with\nthis information.  The second phase is responsible for  cross-reference\nand the composition of the output.  Each phase has an engine  file  and\none or more description files, that describe the source format and  the\noutput format.  This distribution only have a description of Lua source\nfiles and another for HTML output files.\n\nSome technical documentation can  be  built  running  LuaDoc  over  its\nfiles.\n\nPlease send any comments and bug reports to tomas@tecgraf.puc-rio.br\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/keplerproject.github.io%2Fluadoc%2F","html_url":"https://awesome.ecosyste.ms/projects/keplerproject.github.io%2Fluadoc%2F","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/keplerproject.github.io%2Fluadoc%2F/lists"}