From a19b1b98ef9013c43079081caa766257f87ff553 Mon Sep 17 00:00:00 2001 From: pardeike-bot Date: Fri, 20 Dec 2024 12:08:17 +0000 Subject: [PATCH] Update documentation [skip ci] --- docs/api/HarmonyLib.AccessTools.html | 20 ++-- docs/api/HarmonyLib.Traverse.html | 142 ++++++++++++++++++++++----- docs/manifest.json | 4 +- docs/xrefmap.yml | 39 ++++++++ 4 files changed, 171 insertions(+), 34 deletions(-) diff --git a/docs/api/HarmonyLib.AccessTools.html b/docs/api/HarmonyLib.AccessTools.html index c66977d6..a00778c0 100644 --- a/docs/api/HarmonyLib.AccessTools.html +++ b/docs/api/HarmonyLib.AccessTools.html @@ -371,7 +371,7 @@
Returns
Improve this Doc - View Source + View Source

CombinedHashCode(IEnumerable<Object>)

@@ -3709,7 +3709,7 @@
Returns
Improve this Doc - View Source + View Source

IsClass(Type)

@@ -3825,7 +3825,7 @@
Type Parameters
Improve this Doc - View Source + View Source

IsFloatingPoint(Type)

@@ -3875,7 +3875,7 @@
Returns
Improve this Doc - View Source + View Source

IsInteger(Type)

@@ -3925,7 +3925,7 @@
Returns
Improve this Doc - View Source + View Source

IsNumber(Type)

@@ -3975,7 +3975,7 @@
Returns
Improve this Doc - View Source + View Source

IsOfNullableType<T>(T)

@@ -4041,7 +4041,7 @@
Type Parameters
Improve this Doc - View Source + View Source

IsStatic(MemberInfo)

@@ -4091,7 +4091,7 @@
Returns
Improve this Doc - View Source + View Source

IsStruct(Type)

@@ -4141,7 +4141,7 @@
Returns
Improve this Doc - View Source + View Source

IsValue(Type)

@@ -4191,7 +4191,7 @@
Returns
Improve this Doc - View Source + View Source

IsVoid(Type)

diff --git a/docs/api/HarmonyLib.Traverse.html b/docs/api/HarmonyLib.Traverse.html index 3eea7ed6..2919c8b3 100644 --- a/docs/api/HarmonyLib.Traverse.html +++ b/docs/api/HarmonyLib.Traverse.html @@ -164,7 +164,7 @@

Fields Improve this Doc - View Source + View Source

CopyFields

A default field action that copies fields to fields

@@ -189,6 +189,104 @@
Field Value
+

Properties +

+ + | + Improve this Doc + + + View Source + + +

IsField

+

Checks if the current traverse instance is for a field

+
+
+
Declaration
+
+ 
public bool IsField { get; }
+
+
Property Value
+ + + + + + + + + + + + + +
TypeDescription
System.Boolean

True if its a field

+
+ + | + Improve this Doc + + + View Source + + +

IsProperty

+

Checks if the current traverse instance is for a property

+
+
+
Declaration
+
+ 
public bool IsProperty { get; }
+
+
Property Value
+ + + + + + + + + + + + + +
TypeDescription
System.Boolean

True if its a property

+
+ + | + Improve this Doc + + + View Source + + +

IsWriteable

+

Checks if the current field or property is writeable

+
+
+
Declaration
+
+ 
public bool IsWriteable { get; }
+
+
Property Value
+ + + + + + + + + + + + + +
TypeDescription
System.Boolean

True if writing is possible

+

Methods

@@ -394,7 +492,7 @@
Returns
Improve this Doc - View Source + View Source

Field(String)

@@ -444,7 +542,7 @@
Returns
Improve this Doc - View Source + View Source

Field<T>(String)

@@ -510,7 +608,7 @@
Type Parameters
Improve this Doc - View Source + View Source

FieldExists()

@@ -542,7 +640,7 @@
Returns
Improve this Doc - View Source + View Source

Fields()

@@ -802,7 +900,7 @@
Returns
Improve this Doc - View Source + View Source

IterateFields(Object, Action<Traverse>)

@@ -842,7 +940,7 @@
Parameters
Improve this Doc - View Source + View Source

IterateFields(Object, Object, Action<Traverse, Traverse>)

@@ -888,7 +986,7 @@
Parameters
Improve this Doc - View Source + View Source

IterateFields(Object, Object, Action<String, Traverse, Traverse>)

@@ -934,7 +1032,7 @@
Parameters
Improve this Doc - View Source + View Source

IterateProperties(Object, Action<Traverse>)

@@ -974,7 +1072,7 @@
Parameters
Improve this Doc - View Source + View Source

IterateProperties(Object, Object, Action<Traverse, Traverse>)

@@ -1020,7 +1118,7 @@
Parameters
Improve this Doc - View Source + View Source

IterateProperties(Object, Object, Action<String, Traverse, Traverse>)

@@ -1066,7 +1164,7 @@
Parameters
Improve this Doc - View Source + View Source

Method(String, Object[])

@@ -1122,7 +1220,7 @@
Returns
Improve this Doc - View Source + View Source

Method(String, Type[], Object[])

@@ -1184,7 +1282,7 @@
Returns
Improve this Doc - View Source + View Source

MethodExists()

@@ -1216,7 +1314,7 @@
Returns
Improve this Doc - View Source + View Source

Methods()

@@ -1248,7 +1346,7 @@
Returns
Improve this Doc - View Source + View Source

Properties()

@@ -1280,7 +1378,7 @@
Returns
Improve this Doc - View Source + View Source

Property(String, Object[])

@@ -1336,7 +1434,7 @@
Returns
Improve this Doc - View Source + View Source

Property<T>(String, Object[])

@@ -1408,7 +1506,7 @@
Type Parameters
Improve this Doc - View Source + View Source

PropertyExists()

@@ -1490,7 +1588,7 @@
Returns
Improve this Doc - View Source + View Source

ToString()

@@ -1524,7 +1622,7 @@
Overrides
Improve this Doc - View Source + View Source

Type(String)

@@ -1574,7 +1672,7 @@
Returns
Improve this Doc - View Source + View Source

TypeExists()

diff --git a/docs/manifest.json b/docs/manifest.json index eaca5bff..977a957c 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -45,7 +45,7 @@ "output": { ".html": { "relative_path": "api/HarmonyLib.AccessTools.html", - "hash": "LblyYBN2hHuNU59q5HsbI3zcwjffyvw1cWfq4dOOHPQ=" + "hash": "wHytwH0D0kXB9OTdGieslTK3hRHTuQOZvZVi4JbJjho=" } }, "is_incremental": false, @@ -777,7 +777,7 @@ "output": { ".html": { "relative_path": "api/HarmonyLib.Traverse.html", - "hash": "s+t2hkNxutYw7c3h8fk23w6S/7tr4Q8v7NJCzndieKM=" + "hash": "kjDlKIQKE9Rv9puTr1LHAcDZdA1hGkwHnnBLKWrL6fc=" } }, "is_incremental": false, diff --git a/docs/xrefmap.yml b/docs/xrefmap.yml index 2f529df0..12bc7482 100644 --- a/docs/xrefmap.yml +++ b/docs/xrefmap.yml @@ -6625,6 +6625,45 @@ references: isSpec: "True" fullName: HarmonyLib.Traverse.GetValueType nameWithType: Traverse.GetValueType +- uid: HarmonyLib.Traverse.IsField + name: IsField + href: api/HarmonyLib.Traverse.html#HarmonyLib_Traverse_IsField + commentId: P:HarmonyLib.Traverse.IsField + fullName: HarmonyLib.Traverse.IsField + nameWithType: Traverse.IsField +- uid: HarmonyLib.Traverse.IsField* + name: IsField + href: api/HarmonyLib.Traverse.html#HarmonyLib_Traverse_IsField_ + commentId: Overload:HarmonyLib.Traverse.IsField + isSpec: "True" + fullName: HarmonyLib.Traverse.IsField + nameWithType: Traverse.IsField +- uid: HarmonyLib.Traverse.IsProperty + name: IsProperty + href: api/HarmonyLib.Traverse.html#HarmonyLib_Traverse_IsProperty + commentId: P:HarmonyLib.Traverse.IsProperty + fullName: HarmonyLib.Traverse.IsProperty + nameWithType: Traverse.IsProperty +- uid: HarmonyLib.Traverse.IsProperty* + name: IsProperty + href: api/HarmonyLib.Traverse.html#HarmonyLib_Traverse_IsProperty_ + commentId: Overload:HarmonyLib.Traverse.IsProperty + isSpec: "True" + fullName: HarmonyLib.Traverse.IsProperty + nameWithType: Traverse.IsProperty +- uid: HarmonyLib.Traverse.IsWriteable + name: IsWriteable + href: api/HarmonyLib.Traverse.html#HarmonyLib_Traverse_IsWriteable + commentId: P:HarmonyLib.Traverse.IsWriteable + fullName: HarmonyLib.Traverse.IsWriteable + nameWithType: Traverse.IsWriteable +- uid: HarmonyLib.Traverse.IsWriteable* + name: IsWriteable + href: api/HarmonyLib.Traverse.html#HarmonyLib_Traverse_IsWriteable_ + commentId: Overload:HarmonyLib.Traverse.IsWriteable + isSpec: "True" + fullName: HarmonyLib.Traverse.IsWriteable + nameWithType: Traverse.IsWriteable - uid: HarmonyLib.Traverse.IterateFields(System.Object,System.Action{HarmonyLib.Traverse}) name: IterateFields(Object, Action) href: api/HarmonyLib.Traverse.html#HarmonyLib_Traverse_IterateFields_System_Object_System_Action_HarmonyLib_Traverse__