Skip to content

Commit

Permalink
Update Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
liiir1985 committed Aug 29, 2020
1 parent 423c4f6 commit dd75088
Show file tree
Hide file tree
Showing 20 changed files with 58 additions and 22 deletions.
3 changes: 2 additions & 1 deletion ReadMe.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
ILRuntime
==========
[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/Ourpalm/ILRuntime/blob/master/LICENSE.TXT)
[![release](https://img.shields.io/badge/release-v1.6.3-blue.svg)](https://github.com/Ourpalm/ILRuntime/releases)
[![release](https://img.shields.io/badge/release-v1.6.4-blue.svg)](https://github.com/Ourpalm/ILRuntime/releases)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-blue.svg)](https://github.com/Ourpalm/ILRuntime/pulls)

[English Document](ReadMe-EN.md "Click here for English documents")

[中文在线文档](https://ourpalm.github.io/ILRuntime/)
由于近期墙的问题导致部分地区无法访问Github page,如遇到中文文档无法访问,请尝试翻墙

[Unity Demo Project, Unity示例工程](https://github.com/Ourpalm/ILRuntimeU3D/)

Expand Down
2 changes: 1 addition & 1 deletion docs/public/readme.html
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<nav class="nav">
<div class="border">
<img src="/ILRuntime/public/images/logo.png">
<button class="hiden-in-phone">V1.6.3</button>
<button class="hiden-in-phone">V1.6.4</button>
<button id="btn-menu" class="hiden-in-pc">菜单</button>
<ul class="nav-link hiden-in-phone">
<!--li>
Expand Down
10 changes: 8 additions & 2 deletions docs/public/v1/guide/FastQA.html
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<nav class="nav">
<div class="border">
<img src="/ILRuntime/public/images/logo.png">
<button class="hiden-in-phone">V1.6.3</button>
<button class="hiden-in-phone">V1.6.4</button>
<button id="btn-menu" class="hiden-in-pc">菜单</button>
<ul class="nav-link hiden-in-phone">
<!--li>
Expand Down Expand Up @@ -166,7 +166,13 @@
<h2 id="版本"><a href="#版本" class="headerlink" title="版本"></a>版本</h2><blockquote>
<p>Unity2018.3以上需要用最新ILruntime。<br>最新的发布版本为V1.6,Unity2018以上可通过Package Manager方式安装<br>V1.4已过时,示例工程内的版本已过时,当前最新版本为<a href="https://github.com/Ourpalm/ILRuntime" target="_blank" rel="noopener">master</a>分支。</p>
</blockquote>
<h2 id="编辑器内出现错误"><a href="#编辑器内出现错误" class="headerlink" title="编辑器内出现错误"></a>编辑器内出现错误</h2><h3 id="运行出现报错ObjectDisposedException-Cannot-access-a-closed-Stream"><a href="#运行出现报错ObjectDisposedException-Cannot-access-a-closed-Stream" class="headerlink" title="运行出现报错ObjectDisposedException: Cannot access a closed Stream"></a>运行出现报错ObjectDisposedException: Cannot access a closed Stream</h3><blockquote>
<h2 id="编辑器内的常见问题"><a href="#编辑器内的常见问题" class="headerlink" title="编辑器内的常见问题"></a>编辑器内的常见问题</h2><h3 id="我要怎么才能在Profiler里看见热更内的方法耗时情况呢?"><a href="#我要怎么才能在Profiler里看见热更内的方法耗时情况呢?" class="headerlink" title="我要怎么才能在Profiler里看见热更内的方法耗时情况呢?"></a>我要怎么才能在Profiler里看见热更内的方法耗时情况呢?</h3><blockquote>
<ul>
<li>在ILRuntime的初始化处加入以下代码即可在Profiler中看见热更内方法的耗时情况,无需开启DeepProfile,真机上也可使用<figure class="highlight csharp"><table><tr><td class="code"><pre><span class="line"><span class="meta">#<span class="meta-keyword">if</span> DEBUG &amp;&amp; (UNITY_EDITOR || UNITY_ANDROID || UNITY_IPHONE)</span></span><br><span class="line"> <span class="comment">//由于Unity的Profiler接口只允许在主线程使用,为了避免出异常,需要告诉ILRuntime主线程的线程ID才能正确将函数运行耗时报告给Profiler</span></span><br><span class="line"> appdomain.UnityMainThreadID = System.Threading.Thread.CurrentThread.ManagedThreadId;</span><br><span class="line"><span class="meta">#<span class="meta-keyword">endif</span></span></span><br></pre></td></tr></table></figure>
</li>
</ul>
</blockquote>
<h3 id="运行出现报错ObjectDisposedException-Cannot-access-a-closed-Stream"><a href="#运行出现报错ObjectDisposedException-Cannot-access-a-closed-Stream" class="headerlink" title="运行出现报错ObjectDisposedException: Cannot access a closed Stream"></a>运行出现报错ObjectDisposedException: Cannot access a closed Stream</h3><blockquote>
<p>加载dll的流被关闭了。新版要求流不能关闭,也不能用using写法。新的用法请参见Demo示例</p>
</blockquote>
<h3 id="运行时出现Cannot-find-Adaptor-for-xxxxxxxxx"><a href="#运行时出现Cannot-find-Adaptor-for-xxxxxxxxx" class="headerlink" title="运行时出现Cannot find Adaptor for: xxxxxxxxx"></a>运行时出现Cannot find Adaptor for: xxxxxxxxx</h3><blockquote>
Expand Down
2 changes: 1 addition & 1 deletion docs/public/v1/guide/bind.html
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<nav class="nav">
<div class="border">
<img src="/ILRuntime/public/images/logo.png">
<button class="hiden-in-phone">V1.6.3</button>
<button class="hiden-in-phone">V1.6.4</button>
<button id="btn-menu" class="hiden-in-pc">菜单</button>
<ul class="nav-link hiden-in-phone">
<!--li>
Expand Down
2 changes: 1 addition & 1 deletion docs/public/v1/guide/contribution.html
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<nav class="nav">
<div class="border">
<img src="/ILRuntime/public/images/logo.png">
<button class="hiden-in-phone">V1.6.3</button>
<button class="hiden-in-phone">V1.6.4</button>
<button id="btn-menu" class="hiden-in-pc">菜单</button>
<ul class="nav-link hiden-in-phone">
<!--li>
Expand Down
2 changes: 1 addition & 1 deletion docs/public/v1/guide/cross-domain.html
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<nav class="nav">
<div class="border">
<img src="/ILRuntime/public/images/logo.png">
<button class="hiden-in-phone">V1.6.3</button>
<button class="hiden-in-phone">V1.6.4</button>
<button id="btn-menu" class="hiden-in-pc">菜单</button>
<ul class="nav-link hiden-in-phone">
<!--li>
Expand Down
2 changes: 1 addition & 1 deletion docs/public/v1/guide/delegate.html
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<nav class="nav">
<div class="border">
<img src="/ILRuntime/public/images/logo.png">
<button class="hiden-in-phone">V1.6.3</button>
<button class="hiden-in-phone">V1.6.4</button>
<button id="btn-menu" class="hiden-in-pc">菜单</button>
<ul class="nav-link hiden-in-phone">
<!--li>
Expand Down
2 changes: 1 addition & 1 deletion docs/public/v1/guide/il2cpp.html
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<nav class="nav">
<div class="border">
<img src="/ILRuntime/public/images/logo.png">
<button class="hiden-in-phone">V1.6.3</button>
<button class="hiden-in-phone">V1.6.4</button>
<button id="btn-menu" class="hiden-in-pc">菜单</button>
<ul class="nav-link hiden-in-phone">
<!--li>
Expand Down
4 changes: 2 additions & 2 deletions docs/public/v1/guide/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<nav class="nav">
<div class="border">
<img src="/ILRuntime/public/images/logo.png">
<button class="hiden-in-phone">V1.6.3</button>
<button class="hiden-in-phone">V1.6.4</button>
<button id="btn-menu" class="hiden-in-pc">菜单</button>
<ul class="nav-link hiden-in-phone">
<!--li>
Expand Down Expand Up @@ -161,7 +161,7 @@
</ul>
</section>
<article class="clearfix">
<h2 id="ILRuntime"><a href="#ILRuntime" class="headerlink" title="ILRuntime"></a>ILRuntime</h2><p><a href="https://github.com/Ourpalm/ILRuntime/blob/master/LICENSE.TXT" target="_blank" rel="noopener"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="license"></a> <a href="https://github.com/Ourpalm/ILRuntime/releases" target="_blank" rel="noopener"><img src="https://img.shields.io/badge/release-v1.6.0-blue.svg" alt="release"></a> <a href="https://github.com/Ourpalm/ILRuntime/pulls" target="_blank" rel="noopener"><img src="https://img.shields.io/badge/PRs-welcome-blue.svg" alt="PRs Welcome"></a></p>
<h2 id="ILRuntime"><a href="#ILRuntime" class="headerlink" title="ILRuntime"></a>ILRuntime</h2><p><a href="https://github.com/Ourpalm/ILRuntime/blob/master/LICENSE.TXT" target="_blank" rel="noopener"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="license"></a> <a href="https://github.com/Ourpalm/ILRuntime/releases" target="_blank" rel="noopener"><img src="https://img.shields.io/badge/release-v1.6.4-blue.svg" alt="release"></a> <a href="https://github.com/Ourpalm/ILRuntime/pulls" target="_blank" rel="noopener"><img src="https://img.shields.io/badge/PRs-welcome-blue.svg" alt="PRs Welcome"></a></p>
<p>ILRuntime项目为基于C#的平台(例如Unity)提供了一个<code>纯C#实现</code><code>快速</code><code>方便</code><code>可靠</code>的IL运行时,使得能够在不支持JIT的硬件环境(如iOS)能够实现代码的热更新</p>
<h3 id="ILRuntime的优势"><a href="#ILRuntime的优势" class="headerlink" title="ILRuntime的优势"></a>ILRuntime的优势</h3><p>同市面上的其他热更方案相比,ILRuntime主要有以下优点:</p>
<ul>
Expand Down
2 changes: 1 addition & 1 deletion docs/public/v1/guide/litjson.html
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<nav class="nav">
<div class="border">
<img src="/ILRuntime/public/images/logo.png">
<button class="hiden-in-phone">V1.6.3</button>
<button class="hiden-in-phone">V1.6.4</button>
<button id="btn-menu" class="hiden-in-pc">菜单</button>
<ul class="nav-link hiden-in-phone">
<!--li>
Expand Down
2 changes: 1 addition & 1 deletion docs/public/v1/guide/performance-optimization.html
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<nav class="nav">
<div class="border">
<img src="/ILRuntime/public/images/logo.png">
<button class="hiden-in-phone">V1.6.3</button>
<button class="hiden-in-phone">V1.6.4</button>
<button id="btn-menu" class="hiden-in-pc">菜单</button>
<ul class="nav-link hiden-in-phone">
<!--li>
Expand Down
2 changes: 1 addition & 1 deletion docs/public/v1/guide/principle.html
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<nav class="nav">
<div class="border">
<img src="/ILRuntime/public/images/logo.png">
<button class="hiden-in-phone">V1.6.3</button>
<button class="hiden-in-phone">V1.6.4</button>
<button id="btn-menu" class="hiden-in-pc">菜单</button>
<ul class="nav-link hiden-in-phone">
<!--li>
Expand Down
2 changes: 1 addition & 1 deletion docs/public/v1/guide/redirection.html
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<nav class="nav">
<div class="border">
<img src="/ILRuntime/public/images/logo.png">
<button class="hiden-in-phone">V1.6.3</button>
<button class="hiden-in-phone">V1.6.4</button>
<button id="btn-menu" class="hiden-in-pc">菜单</button>
<ul class="nav-link hiden-in-phone">
<!--li>
Expand Down
2 changes: 1 addition & 1 deletion docs/public/v1/guide/reflection.html
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<nav class="nav">
<div class="border">
<img src="/ILRuntime/public/images/logo.png">
<button class="hiden-in-phone">V1.6.3</button>
<button class="hiden-in-phone">V1.6.4</button>
<button id="btn-menu" class="hiden-in-pc">菜单</button>
<ul class="nav-link hiden-in-phone">
<!--li>
Expand Down
2 changes: 1 addition & 1 deletion docs/public/v1/guide/tutorial.html
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<nav class="nav">
<div class="border">
<img src="/ILRuntime/public/images/logo.png">
<button class="hiden-in-phone">V1.6.3</button>
<button class="hiden-in-phone">V1.6.4</button>
<button id="btn-menu" class="hiden-in-pc">菜单</button>
<ul class="nav-link hiden-in-phone">
<!--li>
Expand Down
14 changes: 12 additions & 2 deletions docs/public/v1/guide/version.html
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<nav class="nav">
<div class="border">
<img src="/ILRuntime/public/images/logo.png">
<button class="hiden-in-phone">V1.6.3</button>
<button class="hiden-in-phone">V1.6.4</button>
<button id="btn-menu" class="hiden-in-pc">菜单</button>
<ul class="nav-link hiden-in-phone">
<!--li>
Expand Down Expand Up @@ -161,7 +161,17 @@
</ul>
</section>
<article class="clearfix">
<h2 id="更新记录"><a href="#更新记录" class="headerlink" title="更新记录"></a>更新记录</h2><h3 id="V1-6-3"><a href="#V1-6-3" class="headerlink" title="V1.6.3"></a>V1.6.3</h3><ul>
<h2 id="更新记录"><a href="#更新记录" class="headerlink" title="更新记录"></a>更新记录</h2><h3 id="V1-6-4"><a href="#V1-6-4" class="headerlink" title="V1.6.4"></a>V1.6.4</h3><ul>
<li>修正一个使用委托返回经过值类型绑定过的值类型时造成的栈损坏问题</li>
<li>修正一个自动生成跨域继承适配器代码时,无参数虚函数适配代码执行的报错</li>
<li>修正一个自动生成跨域继承适配器代码对接口方法生成后,某些情况下导致StackOverflow无限递归的Bug</li>
<li>修正Type.ToString结果和原生不一致的问题</li>
<li>修正泛型嵌套数组T[][]字段初始化时的报错问题</li>
<li>修正一个泛型方法匹配的Bug</li>
<li>修正一个泛型数组作为参数时方法匹配的错误</li>
<li>删掉一个C#7语法使用以提高兼容性</li>
</ul>
<h3 id="V1-6-3"><a href="#V1-6-3" class="headerlink" title="V1.6.3"></a>V1.6.3</h3><ul>
<li>修复对泛型字段赋值导致栈损坏的Bug</li>
<li>修复由跨域继承适配器代码生成器自动生成的代码,导致运行时进入错误的类方法的Bug</li>
<li>修复一个在静态方法中实例化对象导致运行出错的Bug</li>
Expand Down
12 changes: 11 additions & 1 deletion docs/source/src/v1/guide/FastQA.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,17 @@ order: 1030
> 最新的发布版本为V1.6,Unity2018以上可通过Package Manager方式安装
> V1.4已过时,示例工程内的版本已过时,当前最新版本为[master]分支。
## 编辑器内出现错误
## 编辑器内的常见问题

### 我要怎么才能在Profiler里看见热更内的方法耗时情况呢?

>- 在ILRuntime的初始化处加入以下代码即可在Profiler中看见热更内方法的耗时情况,无需开启DeepProfile,真机上也可使用
```csharp
#if DEBUG && (UNITY_EDITOR || UNITY_ANDROID || UNITY_IPHONE)
//由于Unity的Profiler接口只允许在主线程使用,为了避免出异常,需要告诉ILRuntime主线程的线程ID才能正确将函数运行耗时报告给Profiler
appdomain.UnityMainThreadID = System.Threading.Thread.CurrentThread.ManagedThreadId;
#endif
```

### 运行出现报错ObjectDisposedException: Cannot access a closed Stream

Expand Down
2 changes: 1 addition & 1 deletion docs/source/src/v1/guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ order: 0

## ILRuntime

[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/Ourpalm/ILRuntime/blob/master/LICENSE.TXT) [![release](https://img.shields.io/badge/release-v1.6.0-blue.svg)](https://github.com/Ourpalm/ILRuntime/releases) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-blue.svg)](https://github.com/Ourpalm/ILRuntime/pulls)
[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/Ourpalm/ILRuntime/blob/master/LICENSE.TXT) [![release](https://img.shields.io/badge/release-v1.6.4-blue.svg)](https://github.com/Ourpalm/ILRuntime/releases) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-blue.svg)](https://github.com/Ourpalm/ILRuntime/pulls)

ILRuntime项目为基于C#的平台(例如Unity)提供了一个`纯C#实现``快速``方便``可靠`的IL运行时,使得能够在不支持JIT的硬件环境(如iOS)能够实现代码的热更新

Expand Down
9 changes: 9 additions & 0 deletions docs/source/src/v1/guide/version.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,15 @@ order: 1
---

## 更新记录
### V1.6.4
- 修正一个使用委托返回经过值类型绑定过的值类型时造成的栈损坏问题
- 修正一个自动生成跨域继承适配器代码时,无参数虚函数适配代码执行的报错
- 修正一个自动生成跨域继承适配器代码对接口方法生成后,某些情况下导致StackOverflow无限递归的Bug
- 修正Type.ToString结果和原生不一致的问题
- 修正泛型嵌套数组T[][]字段初始化时的报错问题
- 修正一个泛型方法匹配的Bug
- 修正一个泛型数组作为参数时方法匹配的错误
- 删掉一个C#7语法使用以提高兼容性

### V1.6.3
- 修复对泛型字段赋值导致栈损坏的Bug
Expand Down
2 changes: 1 addition & 1 deletion docs/source/themes/catlib/layout/page.ejs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<nav class="nav">
<div class="border">
<img src="<%- url_for('images/logo.png')%>" />
<button class="hiden-in-phone">V1.6.3</button>
<button class="hiden-in-phone">V1.6.4</button>
<button id="btn-menu" class="hiden-in-pc">菜单</button>
<ul class="nav-link hiden-in-phone">
<!--li>
Expand Down

0 comments on commit dd75088

Please sign in to comment.