Skip to content

Commit 0cc9d1c

Browse files
committed
DOCATT-8611: Filter out the docs for internal platformUserAccountXXX
1 parent 130013b commit 0cc9d1c

File tree

2 files changed

+11
-1
lines changed

2 files changed

+11
-1
lines changed

Packages/com.unity.inputsystem/Documentation~/filter.yml

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,4 +87,11 @@ apiRules:
8787
type: Type
8888
- exclude:
8989
uidRegex: ^UnityEngine\.InputSystem\.XR\.EyesControl$
90-
type: Type
90+
type: Type
91+
- exclude:
92+
uidRegex: ^UnityEngine\.InputSystem\.Users\.InputUser\.platformAccount.*$
93+
type: Member
94+
- exclude:
95+
uidRegex: ^UnityEngine\.InputSystem\.Users\.InputUser\.FindUserByAccount$
96+
type: Method
97+

Packages/com.unity.inputsystem/InputSystem/Plugins/Users/InputUser.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,7 @@ public int index
102102
public uint id => m_Id;
103103

104104
////TODO: bring documentation for these back when user management is implemented on Xbox and PS
105+
////For now the docs are filtered out (see Documentation~/filter.yml)
105106
public InputUserAccountHandle? platformUserAccountHandle => s_GlobalState.allUserData[index].platformUserAccountHandle;
106107
public string platformUserAccountName => s_GlobalState.allUserData[index].platformUserAccountName;
107108
public string platformUserAccountId => s_GlobalState.allUserData[index].platformUserAccountId;
@@ -767,6 +768,8 @@ public static int GetUnpairedInputDevices(ref InputControlList<InputDevice> list
767768
return s_GlobalState.allUsers[userIndex];
768769
}
769770

771+
772+
////Doc is filtered out (see Documentation~/filter.yml)
770773
public static InputUser? FindUserByAccount(InputUserAccountHandle platformUserAccountHandle)
771774
{
772775
if (platformUserAccountHandle == default(InputUserAccountHandle))

0 commit comments

Comments
 (0)