Skip to content

Commit 0072943

Browse files
pardeikepardeike
committed
draft for docs
1 parent dff846b commit 0072943

97 files changed

Lines changed: 51953 additions & 1265 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/docs.yml‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Build and Deploy Documentation
2+
3+
on:
4+
push:
5+
branches: [ master ]
6+
paths:
7+
- 'Documentation/**'
8+
- 'Harmony/**'
9+
- 'Lib.Harmony/**'
10+
- '.github/workflows/docs.yml'
11+
12+
jobs:
13+
build:
14+
runs-on: windows-latest
15+
16+
steps:
17+
- uses: actions/checkout@v3
18+
19+
- name: Setup .NET
20+
uses: actions/setup-dotnet@v3
21+
with:
22+
dotnet-version: 6.0.x
23+
24+
- name: Install DocFX
25+
run: dotnet tool install -g docfx
26+
27+
- name: Build Library
28+
run: dotnet build -c Debug -f net35 .\Lib.Harmony\Lib.Harmony.csproj
29+
30+
- name: Build Documentation
31+
run: docfx Documentation/docfx.json
32+
33+
- name: Deploy to GitHub Pages
34+
uses: peaceiris/actions-gh-pages@v3
35+
if: github.ref == 'refs/heads/master'
36+
with:
37+
github_token: ${{ secrets.GITHUB_TOKEN }}
38+
publish_dir: ./docs
39+
force_orphan: true

‎Documentation/.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
api
2+
docs

‎Documentation/docfx.json‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@
33
{
44
"src": [
55
{
6-
"src": "../Lib.Harmony",
7-
"files": [ "Lib.Harmony.csproj" ]
6+
"src": "..",
7+
"files": [ "Lib.Harmony/bin/Debug/net35/0Harmony.dll" ],
8+
"exclude": [ "**/obj/**", "**/bin/Release/**" ]
89
}
910
],
1011
"dest": "api",
1112
"filter": "filterConfig.yml",
12-
"properties": {
13-
"TargetFramework": "net35"
14-
}
13+
"disableGitFeatures": false,
14+
"disableDefaultFilter": false
1515
}
1616
],
1717
"build": {

‎docs/api/HarmonyLib.AccessTools.FieldRef-1.html‎

Lines changed: 304 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,304 @@
1+
<!DOCTYPE html>
2+
<!--[if IE]><![endif]-->
3+
<html>
4+
5+
<head>
6+
<meta charset="utf-8">
7+
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
8+
<title>Delegate AccessTools.FieldRef&lt;F&gt;
9+
</title>
10+
<meta name="viewport" content="width=device-width">
11+
<meta name="title" content="Delegate AccessTools.FieldRef&lt;F&gt;
12+
">
13+
<meta name="generator" content="docfx 2.48.1.0">
14+
15+
<link rel="shortcut icon" href="../favicon.ico">
16+
<link rel="stylesheet" href="../styles/docfx.vendor.css">
17+
<link rel="stylesheet" href="../styles/docfx.css">
18+
<link rel="stylesheet" href="../styles/main.css">
19+
<meta property="docfx:navrel" content="../toc.html">
20+
<meta property="docfx:tocrel" content="toc.html">
21+
22+
23+
24+
</head>
25+
<body data-spy="scroll" data-target="#affix" data-offset="120">
26+
<div id="wrapper">
27+
<header>
28+
29+
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
30+
<div class="container">
31+
<div class="navbar-header">
32+
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
33+
<span class="sr-only">Toggle navigation</span>
34+
<span class="icon-bar"></span>
35+
<span class="icon-bar"></span>
36+
<span class="icon-bar"></span>
37+
</button>
38+
39+
<a class="navbar-brand" href="../index.html">
40+
<img id="logo" class="svg" src="../logo.svg" alt="">
41+
</a>
42+
</div>
43+
<div class="collapse navbar-collapse" id="navbar">
44+
<form class="navbar-form navbar-right" role="search" id="search">
45+
<div class="form-group">
46+
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
47+
</div>
48+
</form>
49+
</div>
50+
</div>
51+
</nav>
52+
53+
<div class="subnav navbar navbar-default">
54+
<div class="container hide-when-search" id="breadcrumb">
55+
<ul class="breadcrumb">
56+
<li></li>
57+
</ul>
58+
</div>
59+
</div>
60+
</header>
61+
<div role="main" class="container body-content hide-when-search">
62+
63+
<div class="sidenav hide-when-search">
64+
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
65+
<div class="sidetoggle collapse" id="sidetoggle">
66+
<div id="sidetoc"></div>
67+
</div>
68+
</div>
69+
<div class="article row grid-right">
70+
<div class="col-md-10">
71+
<article class="content wrap" id="_content" data-uid="HarmonyLib.AccessTools.FieldRef`1">
72+
73+
74+
<h1 id="HarmonyLib_AccessTools_FieldRef_1" data-uid="HarmonyLib.AccessTools.FieldRef`1" class="text-break">Delegate AccessTools.FieldRef&lt;F&gt;
75+
</h1>
76+
<div class="markdown level0 summary"><p>A readable/assignable reference delegate to a static field</p>
77+
</div>
78+
<div class="markdown level0 conceptual"></div>
79+
<h6><strong>Namespace</strong>: <a class="xref" href="HarmonyLib.html">HarmonyLib</a></h6>
80+
<h6><strong>Assembly</strong>: 0Harmony.dll</h6>
81+
<h5 id="HarmonyLib_AccessTools_FieldRef_1_syntax">Syntax</h5>
82+
<div class="codewrapper">
83+
<pre><code class="lang-csharp hljs">public delegate F FieldRef&lt;F&gt;();</code></pre>
84+
</div>
85+
<h5 class="returns">Returns</h5>
86+
<table class="table table-bordered table-striped table-condensed">
87+
<thead>
88+
<tr>
89+
<th>Type</th>
90+
<th>Description</th>
91+
</tr>
92+
</thead>
93+
<tbody>
94+
<tr>
95+
<td><span class="xref">F</span></td>
96+
<td><p>A readable/assignable reference to the field</p>
97+
</td>
98+
</tr>
99+
</tbody>
100+
</table>
101+
<h5 class="typeParameters">Type Parameters</h5>
102+
<table class="table table-bordered table-striped table-condensed">
103+
<thead>
104+
<tr>
105+
<th>Name</th>
106+
<th>Description</th>
107+
</tr>
108+
</thead>
109+
<tbody>
110+
<tr>
111+
<td><span class="parametername">F</span></td>
112+
<td><p>The type of the field; or if the field's type is a reference type (a class or interface, NOT a struct or other value type),
113+
a type that <span class="xref">System.Type.IsAssignableFrom(System.Type)</span> that type; or if the field's type is an enum type,
114+
either that type or the underlying integral type of that enum type</p>
115+
</td>
116+
</tr>
117+
</tbody>
118+
</table>
119+
<h3 id="constructors">Constructors
120+
</h3>
121+
122+
123+
<a id="HarmonyLib_AccessTools_FieldRef_1__ctor_" data-uid="HarmonyLib.AccessTools.FieldRef`1.#ctor*"></a>
124+
<h4 id="HarmonyLib_AccessTools_FieldRef_1__ctor_System_Object_System_IntPtr_" data-uid="HarmonyLib.AccessTools.FieldRef`1.#ctor(System.Object,System.IntPtr)">FieldRef(Object, IntPtr)</h4>
125+
<div class="markdown level1 summary"></div>
126+
<div class="markdown level1 conceptual"></div>
127+
<h5 class="decalaration">Declaration</h5>
128+
<div class="codewrapper">
129+
<pre><code class="lang-csharp hljs">public FieldRef(object object, IntPtr method)</code></pre>
130+
</div>
131+
<h5 class="parameters">Parameters</h5>
132+
<table class="table table-bordered table-striped table-condensed">
133+
<thead>
134+
<tr>
135+
<th>Type</th>
136+
<th>Name</th>
137+
<th>Description</th>
138+
</tr>
139+
</thead>
140+
<tbody>
141+
<tr>
142+
<td><span class="xref">System.Object</span></td>
143+
<td><span class="parametername">object</span></td>
144+
<td></td>
145+
</tr>
146+
<tr>
147+
<td><span class="xref">System.IntPtr</span></td>
148+
<td><span class="parametername">method</span></td>
149+
<td></td>
150+
</tr>
151+
</tbody>
152+
</table>
153+
<h3 id="methods">Methods
154+
</h3>
155+
156+
157+
<a id="HarmonyLib_AccessTools_FieldRef_1_BeginInvoke_" data-uid="HarmonyLib.AccessTools.FieldRef`1.BeginInvoke*"></a>
158+
<h4 id="HarmonyLib_AccessTools_FieldRef_1_BeginInvoke_System_AsyncCallback_System_Object_" data-uid="HarmonyLib.AccessTools.FieldRef`1.BeginInvoke(System.AsyncCallback,System.Object)">BeginInvoke(AsyncCallback, Object)</h4>
159+
<div class="markdown level1 summary"></div>
160+
<div class="markdown level1 conceptual"></div>
161+
<h5 class="decalaration">Declaration</h5>
162+
<div class="codewrapper">
163+
<pre><code class="lang-csharp hljs">public virtual IAsyncResult BeginInvoke(AsyncCallback callback, object object)</code></pre>
164+
</div>
165+
<h5 class="parameters">Parameters</h5>
166+
<table class="table table-bordered table-striped table-condensed">
167+
<thead>
168+
<tr>
169+
<th>Type</th>
170+
<th>Name</th>
171+
<th>Description</th>
172+
</tr>
173+
</thead>
174+
<tbody>
175+
<tr>
176+
<td><span class="xref">System.AsyncCallback</span></td>
177+
<td><span class="parametername">callback</span></td>
178+
<td></td>
179+
</tr>
180+
<tr>
181+
<td><span class="xref">System.Object</span></td>
182+
<td><span class="parametername">object</span></td>
183+
<td></td>
184+
</tr>
185+
</tbody>
186+
</table>
187+
<h5 class="returns">Returns</h5>
188+
<table class="table table-bordered table-striped table-condensed">
189+
<thead>
190+
<tr>
191+
<th>Type</th>
192+
<th>Description</th>
193+
</tr>
194+
</thead>
195+
<tbody>
196+
<tr>
197+
<td><span class="xref">System.IAsyncResult</span></td>
198+
<td></td>
199+
</tr>
200+
</tbody>
201+
</table>
202+
203+
204+
<a id="HarmonyLib_AccessTools_FieldRef_1_EndInvoke_" data-uid="HarmonyLib.AccessTools.FieldRef`1.EndInvoke*"></a>
205+
<h4 id="HarmonyLib_AccessTools_FieldRef_1_EndInvoke_System_IAsyncResult_" data-uid="HarmonyLib.AccessTools.FieldRef`1.EndInvoke(System.IAsyncResult)">EndInvoke(IAsyncResult)</h4>
206+
<div class="markdown level1 summary"></div>
207+
<div class="markdown level1 conceptual"></div>
208+
<h5 class="decalaration">Declaration</h5>
209+
<div class="codewrapper">
210+
<pre><code class="lang-csharp hljs">public virtual F EndInvoke(IAsyncResult result)</code></pre>
211+
</div>
212+
<h5 class="parameters">Parameters</h5>
213+
<table class="table table-bordered table-striped table-condensed">
214+
<thead>
215+
<tr>
216+
<th>Type</th>
217+
<th>Name</th>
218+
<th>Description</th>
219+
</tr>
220+
</thead>
221+
<tbody>
222+
<tr>
223+
<td><span class="xref">System.IAsyncResult</span></td>
224+
<td><span class="parametername">result</span></td>
225+
<td></td>
226+
</tr>
227+
</tbody>
228+
</table>
229+
<h5 class="returns">Returns</h5>
230+
<table class="table table-bordered table-striped table-condensed">
231+
<thead>
232+
<tr>
233+
<th>Type</th>
234+
<th>Description</th>
235+
</tr>
236+
</thead>
237+
<tbody>
238+
<tr>
239+
<td><span class="xref">F</span></td>
240+
<td></td>
241+
</tr>
242+
</tbody>
243+
</table>
244+
245+
246+
<a id="HarmonyLib_AccessTools_FieldRef_1_Invoke_" data-uid="HarmonyLib.AccessTools.FieldRef`1.Invoke*"></a>
247+
<h4 id="HarmonyLib_AccessTools_FieldRef_1_Invoke" data-uid="HarmonyLib.AccessTools.FieldRef`1.Invoke">Invoke()</h4>
248+
<div class="markdown level1 summary"></div>
249+
<div class="markdown level1 conceptual"></div>
250+
<h5 class="decalaration">Declaration</h5>
251+
<div class="codewrapper">
252+
<pre><code class="lang-csharp hljs">public virtual F Invoke()</code></pre>
253+
</div>
254+
<h5 class="returns">Returns</h5>
255+
<table class="table table-bordered table-striped table-condensed">
256+
<thead>
257+
<tr>
258+
<th>Type</th>
259+
<th>Description</th>
260+
</tr>
261+
</thead>
262+
<tbody>
263+
<tr>
264+
<td><span class="xref">F</span></td>
265+
<td></td>
266+
</tr>
267+
</tbody>
268+
</table>
269+
</article>
270+
</div>
271+
272+
<div class="hidden-sm col-md-2" role="complementary">
273+
<div class="sideaffix">
274+
<div class="contribution">
275+
<ul class="nav">
276+
</ul>
277+
</div>
278+
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
279+
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
280+
</nav>
281+
</div>
282+
</div>
283+
</div>
284+
</div>
285+
286+
<footer>
287+
<div class="grad-bottom"></div>
288+
<div class="footer">
289+
<div class="container">
290+
<span class="pull-right">
291+
<a href="#top">Back to top</a>
292+
</span>
293+
294+
<span>Generated by <strong>DocFX</strong></span>
295+
</div>
296+
</div>
297+
</footer>
298+
</div>
299+
300+
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
301+
<script type="text/javascript" src="../styles/docfx.js"></script>
302+
<script type="text/javascript" src="../styles/main.js"></script>
303+
</body>
304+
</html>

0 commit comments

Comments
 (0)