From 64215c57227ee5c077a2c65374fa0e514065e63f Mon Sep 17 00:00:00 2001 From: EvilFactory Date: Sat, 18 Mar 2023 15:43:10 -0300 Subject: [PATCH] Allow specifying realm when generating docs for a single type and added PlayerInput to docs --- luacs-docs/lua/baseluadocs/PlayerInput.lua | 8 ++++++++ luacs-docs/lua/scripts/LuaDocsGenerator/DocsGenerator.cs | 8 ++++---- luacs-docs/lua/scripts/LuaDocsGenerator/Program.cs | 5 +++-- 3 files changed, 15 insertions(+), 6 deletions(-) create mode 100644 luacs-docs/lua/baseluadocs/PlayerInput.lua diff --git a/luacs-docs/lua/baseluadocs/PlayerInput.lua b/luacs-docs/lua/baseluadocs/PlayerInput.lua new file mode 100644 index 000000000..f015dd40a --- /dev/null +++ b/luacs-docs/lua/baseluadocs/PlayerInput.lua @@ -0,0 +1,8 @@ +-- luacheck: ignore 111 + +--[[-- +Barotrauma.PlayerInput +]] +-- @code PlayerInput +-- @pragma nostrip +local PlayerInput = {} \ No newline at end of file diff --git a/luacs-docs/lua/scripts/LuaDocsGenerator/DocsGenerator.cs b/luacs-docs/lua/scripts/LuaDocsGenerator/DocsGenerator.cs index 0ac2d61ad..39d37f842 100644 --- a/luacs-docs/lua/scripts/LuaDocsGenerator/DocsGenerator.cs +++ b/luacs-docs/lua/scripts/LuaDocsGenerator/DocsGenerator.cs @@ -483,7 +483,7 @@ local {type.Name} = {{}}".ReplaceLineEndings("\n"); return baseLuaText; } - public static void GenerateDocs(Type type, string baseFile, string outFile, string? categoryName = null) + public static void GenerateDocs(Type type, string baseFile, string outFile, string? categoryName = null, string realm = "shared") { categoryName ??= type.Name; var sb = new StringBuilder(); @@ -503,21 +503,21 @@ local {type.Name} = {{}}".ReplaceLineEndings("\n"); { case MemberTypes.Method: { - sb.Append(ConvertAnnotation(type, (MethodInfo)member, "shared")); + sb.Append(ConvertAnnotation(type, (MethodInfo)member, realm)); sb.AppendLine(); break; } case MemberTypes.Field: { - sb.Append(ConvertAnnotation(type, (FieldInfo)member, "shared")); + sb.Append(ConvertAnnotation(type, (FieldInfo)member, realm)); sb.AppendLine(); break; } case MemberTypes.Property: { - sb.Append(ConvertAnnotation(type, (PropertyInfo)member, "shared")); + sb.Append(ConvertAnnotation(type, (PropertyInfo)member, realm)); sb.AppendLine(); break; } diff --git a/luacs-docs/lua/scripts/LuaDocsGenerator/Program.cs b/luacs-docs/lua/scripts/LuaDocsGenerator/Program.cs index 1f65faa5a..94a1ed1d4 100644 --- a/luacs-docs/lua/scripts/LuaDocsGenerator/Program.cs +++ b/luacs-docs/lua/scripts/LuaDocsGenerator/Program.cs @@ -10,9 +10,9 @@ namespace LuaDocsGenerator private static string generatedDir = ""; private static string baseLuaDir = ""; - private static void GenerateDocs(string file, string? categoryName = null) + private static void GenerateDocs(string file, string? categoryName = null, string realm = "shared") { - DocsGenerator.GenerateDocs(typeof(T), $"{baseLuaDir}/{file}", $"{generatedDir}/{file}", categoryName); + DocsGenerator.GenerateDocs(typeof(T), $"{baseLuaDir}/{file}", $"{generatedDir}/{file}", categoryName, realm); } private static void GenerateDocs(string file, string? categoryName = null) @@ -87,6 +87,7 @@ namespace LuaDocsGenerator GenerateDocs("StructurePrefab.lua"); GenerateDocs("PhysicsBody.lua"); GenerateDocs("Limb.lua"); + GenerateDocs("PlayerInput.lua", "PlayerInput", "client"); GenerateEnum("CauseOfDeathType.lua"); GenerateEnum("CharacterTeamType.lua");