Skip to content

Commit

Permalink
Add even more documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Happyrobot33 committed Apr 15, 2024
1 parent e6c49b5 commit a1378d8
Show file tree
Hide file tree
Showing 75 changed files with 1,207 additions and 65 deletions.
2 changes: 1 addition & 1 deletion Assembly-CSharp.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@
<UnityVersion>2022.3.6f1</UnityVersion>
</PropertyGroup>
<ItemGroup>
<Analyzer Include="C:\Users\mherber\.vscode\extensions\visualstudiotoolsforunity.vstuc-1.0.0\Analyzers\Microsoft.Unity.Analyzers.dll" />
<Analyzer Include="C:\Users\mherber\.vscode\extensions\visualstudiotoolsforunity.vstuc-1.0.1\Analyzers\Microsoft.Unity.Analyzers.dll" />
<Analyzer Include="C:\Users\mherber\Documents\2022.3.6f1\Editor\Data\Tools\Unity.SourceGenerators\Unity.SourceGenerators.dll" />
<Analyzer Include="C:\Users\mherber\Documents\2022.3.6f1\Editor\Data\Tools\Unity.SourceGenerators\Unity.Properties.SourceGenerator.dll" />
</ItemGroup>
Expand Down
2 changes: 1 addition & 1 deletion Cinemachine.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@
<UnityVersion>2022.3.6f1</UnityVersion>
</PropertyGroup>
<ItemGroup>
<Analyzer Include="C:\Users\mherber\.vscode\extensions\visualstudiotoolsforunity.vstuc-1.0.0\Analyzers\Microsoft.Unity.Analyzers.dll" />
<Analyzer Include="C:\Users\mherber\.vscode\extensions\visualstudiotoolsforunity.vstuc-1.0.1\Analyzers\Microsoft.Unity.Analyzers.dll" />
<Analyzer Include="C:\Users\mherber\Documents\2022.3.6f1\Editor\Data\Tools\Unity.SourceGenerators\Unity.SourceGenerators.dll" />
<Analyzer Include="C:\Users\mherber\Documents\2022.3.6f1\Editor\Data\Tools\Unity.SourceGenerators\Unity.Properties.SourceGenerator.dll" />
</ItemGroup>
Expand Down
29 changes: 28 additions & 1 deletion CodeCoverage/Program.cs
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,13 @@ public static void Main(string[] args)
//populate the namespace blacklist
namespaceBlacklist.Add("VRC.SDKBase.Validation.*");
namespaceBlacklist.Add("VRC.SDK3");
namespaceBlacklist.Add("VRC.SDKBase.RPC");
namespaceBlacklist.Add("VRC.SDKBase.Network");
namespaceBlacklist.Add("VRC.SDKBase.Editor.Attributes");
namespaceBlacklist.Add("VRC.Core.Burst");
namespaceBlacklist.Add("VRC.SDKBase.Editor.Source");
namespaceBlacklist.Add("VRC.SDKBase.Editor.V3");
namespaceBlacklist.Add("VRC.SDKBase.Editor.Validation");

#region XML Handling
//load ALL XML files recursively at once and merge them into a single XML
Expand Down Expand Up @@ -444,7 +451,27 @@ private static void PopulateAssemblyData(string testAssemblyPath, ref List<names
namespaceAssemblyData entry = dict.Find(x => x.namespaceName == namespaceName);

entry.publicProperties.AddRange(type.Properties.Where(x => x.Accessibility == Accessibility.Public));
entry.publicMethods.AddRange(type.Methods.Where(x => x.Accessibility == Accessibility.Public));

//loop through the public methods, and get all .ctor methods
foreach (IMethod method in type.Methods)
{
if (method.Accessibility == Accessibility.Public)
{
if (method.Name == ".ctor")
{
//determine if the .ctor is part of a enum
if (type.Kind == TypeKind.Enum)
{
//if it is, skip it
continue;
}
}

entry.publicMethods.Add(method);
}
}

//entry.publicMethods.AddRange(type.Methods.Where(x => x.Accessibility == Accessibility.Public));
//do some extra logic to only add fields that are not delegates
foreach (IField field in type.Fields)
{
Expand Down
Binary file modified CodeCoverage/bin/Debug/net8.0/CodeCoverage.dll
Binary file not shown.
Binary file modified CodeCoverage/bin/Debug/net8.0/CodeCoverage.exe
Binary file not shown.
2 changes: 1 addition & 1 deletion CodeCoverage/obj/Debug/net8.0/CodeCoverage.AssemblyInfo.cs
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
[assembly: System.Reflection.AssemblyCompanyAttribute("CodeCoverage")]
[assembly: System.Reflection.AssemblyConfigurationAttribute("Debug")]
[assembly: System.Reflection.AssemblyFileVersionAttribute("1.0.0.0")]
[assembly: System.Reflection.AssemblyInformationalVersionAttribute("1.0.0+f2021c029c8038fe5b47117b6ec6d06176669be7")]
[assembly: System.Reflection.AssemblyInformationalVersionAttribute("1.0.0+e6c49b5c557a6277da568feb13634577400768ac")]
[assembly: System.Reflection.AssemblyProductAttribute("CodeCoverage")]
[assembly: System.Reflection.AssemblyTitleAttribute("CodeCoverage")]
[assembly: System.Reflection.AssemblyVersionAttribute("1.0.0.0")]
Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@
db67d1cab47e888e145aa3979f5171cd92ac1a0e04cab994efc68de64ff8e092
edb7b81f1b56661d108503b0a35e32ee70dfdee4c771841b5e8eba20ff0f51de
Binary file modified CodeCoverage/obj/Debug/net8.0/CodeCoverage.dll
Binary file not shown.
2 changes: 1 addition & 1 deletion CodeCoverage/obj/Debug/net8.0/CodeCoverage.sourcelink.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documents":{"C:\\Users\\mherber\\Documents\\VRCSDK-Documentation-Project\\*":"https://raw.githubusercontent.com/Happyrobot33/VRCSDK-Documentation-Project/f2021c029c8038fe5b47117b6ec6d06176669be7/*"}}
{"documents":{"C:\\Users\\mherber\\Documents\\VRCSDK-Documentation-Project\\*":"https://raw.githubusercontent.com/Happyrobot33/VRCSDK-Documentation-Project/e6c49b5c557a6277da568feb13634577400768ac/*"}}
Binary file modified CodeCoverage/obj/Debug/net8.0/apphost.exe
Binary file not shown.
Binary file modified CodeCoverage/obj/Debug/net8.0/ref/CodeCoverage.dll
Binary file not shown.
Binary file modified CodeCoverage/obj/Debug/net8.0/refint/CodeCoverage.dll
Binary file not shown.
5 changes: 4 additions & 1 deletion Happyrobot33.VRCSDKDocumentationProject.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@
<UnityVersion>2022.3.6f1</UnityVersion>
</PropertyGroup>
<ItemGroup>
<Analyzer Include="C:\Users\mherber\.vscode\extensions\visualstudiotoolsforunity.vstuc-1.0.0\Analyzers\Microsoft.Unity.Analyzers.dll" />
<Analyzer Include="C:\Users\mherber\.vscode\extensions\visualstudiotoolsforunity.vstuc-1.0.1\Analyzers\Microsoft.Unity.Analyzers.dll" />
<Analyzer Include="C:\Users\mherber\Documents\2022.3.6f1\Editor\Data\Tools\Unity.SourceGenerators\Unity.SourceGenerators.dll" />
<Analyzer Include="C:\Users\mherber\Documents\2022.3.6f1\Editor\Data\Tools\Unity.SourceGenerators\Unity.Properties.SourceGenerator.dll" />
</ItemGroup>
Expand All @@ -73,6 +73,7 @@
<None Include="Packages\com.happyrobot33.vrcsdkdocumentation\Editor\Documentation\VRCSDK3\VRCStation.xml" />
<None Include="Packages\com.happyrobot33.vrcsdkdocumentation\Editor\Documentation\VRCSDK3\DataToken.xml" />
<None Include="Packages\com.happyrobot33.vrcsdkdocumentation\Editor\Editor.asmdef" />
<None Include="Packages\com.happyrobot33.vrcsdkdocumentation\Editor\Documentation\VRCSDKBase\Platform.xml" />
<None Include="Packages\com.happyrobot33.vrcsdkdocumentation\Editor\Documentation\VRCSDK3\VRCUrlInputField.xml" />
<None Include="Packages\com.happyrobot33.vrcsdkdocumentation\Editor\Documentation\VRCSDK3\VRCPickup.xml" />
<None Include="Packages\com.happyrobot33.vrcsdkdocumentation\Editor\Documentation\VRCSDKBase\VRCPlayerApi.xml" />
Expand All @@ -81,7 +82,9 @@
<None Include="Packages\com.happyrobot33.vrcsdkdocumentation\Editor\Documentation\VRCSDK3\DataDictionary.xml" />
<None Include="Packages\com.happyrobot33.vrcsdkdocumentation\Editor\Documentation\VRCSDKBase\VRCUrl.xml" />
<None Include="Packages\com.happyrobot33.vrcsdkdocumentation\Editor\Documentation\VRCSDK3\VRCObjectSync.xml" />
<None Include="Packages\com.happyrobot33.vrcsdkdocumentation\Editor\Documentation\VRCSDKBase\BuildPipeline.xml" />
<None Include="Packages\com.happyrobot33.vrcsdkdocumentation\Editor\Documentation\VRCSDK3\VRCJson.xml" />
<None Include="Packages\com.happyrobot33.vrcsdkdocumentation\Editor\Documentation\VRCSDKBase\VRC_MidiNoteIn.xml" />
<None Include="Packages\com.happyrobot33.vrcsdkdocumentation\Editor\Documentation\VRCSDK3\Video.xml" />
<None Include="Packages\com.happyrobot33.vrcsdkdocumentation\Editor\Documentation\VRCSDK3\VRCAvatarPedestal.xml" />
<None Include="Packages\com.happyrobot33.vrcsdkdocumentation\Editor\Documentation\VRCSDKBase\InputManager.xml" />
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
<?xml version="1.0"?>
<members>
<member name="T:VRC.SDKBase.Editor.BuildPipeline.VRCSDKRequestedBuildType">
<docURL>
https://creators.vrchat.com/sdk/build-pipeline-callbacks-and-interfaces/#ivrcsdkbuildrequestedcallback</docURL>
<summary>
The type of build requested by the user.
</summary>
</member>
<member name="F:VRC.SDKBase.Editor.BuildPipeline.VRCSDKRequestedBuildType.Avatar">
<docURL>
https://creators.vrchat.com/sdk/build-pipeline-callbacks-and-interfaces/#ivrcsdkbuildrequestedcallback</docURL>
<summary>
The user requested an avatar build.
</summary>
</member>
<member name="F:VRC.SDKBase.Editor.BuildPipeline.VRCSDKRequestedBuildType.Scene">
<docURL>
https://creators.vrchat.com/sdk/build-pipeline-callbacks-and-interfaces/#ivrcsdkbuildrequestedcallback</docURL>
<summary>
The user requested a world build.
</summary>
</member>
<member name="T:VRC.SDKBase.Editor.BuildPipeline.IVRCSDKBuildRequestedCallback">
<docURL>
https://creators.vrchat.com/sdk/build-pipeline-callbacks-and-interfaces/#ivrcsdkbuildrequestedcallback</docURL>
<summary>
This interface allows you to perform some logic before the VRChat SDK starts building the content.
</summary>
<remarks>
Returning false from the OnBuildRequested method will abort the build process.
</remarks>
</member>
</members>

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<?xml version="1.0"?>
<members>
<member name="T:VRC.SDKBase.Platform.VRCOrientation">
<docURL>https://creators.vrchat.com/worlds/udon/graph/event-nodes/#onscreenupdate</docURL>
<summary>
the orientation of the player's device.
</summary>
</member>
<member name="F:VRC.SDKBase.Platform.VRCOrientation.Landscape">
<docURL>https://creators.vrchat.com/worlds/udon/graph/event-nodes/#onscreenupdate</docURL>
<summary>
The player's device is in landscape orientation.
</summary>
</member>
<member name="F:VRC.SDKBase.Platform.VRCOrientation.Portrait">
<docURL>https://creators.vrchat.com/worlds/udon/graph/event-nodes/#onscreenupdate</docURL>
<summary>
The player's device is in portrait orientation.
</summary>
</member>
</members>

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit a1378d8

Please sign in to comment.