Skip to content

Commit d366ddb

Browse files
committed
applied changes required by doc tooling 3x
1 parent f27e3c7 commit d366ddb

4 files changed

Lines changed: 20 additions & 4 deletions

File tree

Assets/Tests/InputSystem/DocumentationBasedAPIVerficationTests.cs

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,14 @@ public void OneTimeSetup()
4444
Directory.CreateDirectory(docsPath);
4545
var inputSystemPackageInfo = UnityEditor.PackageManager.PackageInfo.FindForAssetPath("Packages/com.unity.inputsystem");
4646

47+
// PMDT 3.x generates API docs from .csproj files rather than compiled assemblies.
48+
// On CI (fresh clone, no IDE installed), SyncAll() is a no-op and no .sln/.csproj files
49+
// exist yet. Force solution generation via reflection since SyncVS is internal in Unity 6.x.
50+
var syncVsType = Type.GetType("UnityEditor.SyncVS, UnityEditor");
51+
syncVsType?.GetMethod("SyncSolution",
52+
BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Static)
53+
?.Invoke(null, null);
54+
4755
#if HAVE_DOCTOOLS_INSTALLED
4856
(_documentationBuilderLogs, _docsFolder) = Documentation.Instance.GenerateEx(inputSystemPackageInfo, InputSystem.version.ToString(), docsPath);
4957
_docsFolder = Path.Combine(docsPath, _docsFolder);
@@ -394,6 +402,14 @@ private static void CheckHTMLFileLinkConsistency(string htmlFile, List<string> u
394402
if (link.StartsWith("https://"))
395403
continue;
396404

405+
// javascript: URIs are used by the PMDT 3.x HTML theme for collapsible navigation elements
406+
if (link.StartsWith("javascript:"))
407+
continue;
408+
409+
// xref: URIs are unresolved DocFX cross-references to types outside this package
410+
if (link.StartsWith("xref:"))
411+
continue;
412+
397413
if (link == "#top")
398414
continue;
399415

Packages/com.unity.inputsystem/Documentation~/config.json

Lines changed: 0 additions & 1 deletion
This file was deleted.
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
{
22
"hideGlobalNamespace": true,
3+
"DefineConstants": "UNITY_INPUT_SYSTEM_PROJECT_WIDE_ACTIONS",
34
"xref": [
45
"com.unity.xr.openxr",
56
"com.unity.xr.interaction.toolkit"
67
]
7-
}
8+
}

Packages/com.unity.inputsystem/InputSystem/Runtime/InputSystem.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2904,8 +2904,8 @@ public static event Action onSettingsChange
29042904
/// <example>
29052905
/// <code>
29062906
/// InputSystem.customBindingPathValidators += (string bindingPath) => {
2907-
/// // Mark <Gamepad> bindings with a warning
2908-
/// if (!bindingPath.StartsWith("<Gamepad>"))
2907+
/// // Mark &lt;Gamepad&gt; bindings with a warning
2908+
/// if (!bindingPath.StartsWith("&lt;Gamepad&gt;"))
29092909
/// return null;
29102910
///
29112911
/// // Draw the warning information in the Binding Properties panel

0 commit comments

Comments
 (0)