Skip to content

Commit bb430e9

Browse files
committed
Update docs: Fix typo + add important information for plugin development
1 parent 9612fba commit bb430e9

File tree

2 files changed

+6
-1
lines changed

2 files changed

+6
-1
lines changed

docs/documentation.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,7 @@ <h1 id="searching">Searching</h1>
237237
<span class="fl col">
238238
<img class="modalImg" onclick="showModal(this)" src="screenshots/search-reference.png">
239239
<img class="modalImg" onclick="showModal(this)" src="screenshots/search-reference-result.png">
240-
</span>When there is one than one input field for a search, entering only one will widen the range of results. For example, if you do a reference search for <i>Owner=</i><span class="code">java/io/File</span> then the results will show every reference to any member of the <span class="code">File</span> class. However when you specify a <i>Name=</i><span class="code">&lt;init&gt;</span> <i>(constructor's internal name)</i> then the results will show all instantiations of the <span class="code">File</span> class.<br>These images to the left show the result of the search.</p>
240+
</span>When there is more than one input field for a search, entering only one will widen the range of results. For example, if you do a reference search for <i>Owner=</i><span class="code">java/io/File</span> then the results will show every reference to any member of the <span class="code">File</span> class. However when you specify a <i>Name=</i><span class="code">&lt;init&gt;</span> <i>(constructor's internal name)</i> then the results will show all instantiations of the <span class="code">File</span> class.<br>These images to the left show the result of the search.</p>
241241
<h2>Search type table</h2>
242242
<table>
243243
<tr>

docs/plugins.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,8 @@
3535
<a href="#summary"><li>Summary</li></a>
3636
<a href="#setup"><li>Setup</li></a>
3737
<a href="#expansion"><li>Extension</li></a>
38+
<a href="#exporting"><li>Exporting</li></a>
39+
<a href="#examples"><li>Examples</li></a>
3840
<a href="https://github.com/Col-E/Recaf/issues/60"><li>Discussion</li></a>
3941
<!--
4042
<a href="#custom"><li>Plugins &amp;<br>Customization</li></a>
@@ -111,6 +113,9 @@ <h1 id="expansion">Extension</h1>
111113
<span class="line"></span> <span class="keyword">int</span> height();
112114
<span class="line"></span>}
113115
</pre>
116+
<h1 id="exporting">Exporting</h1>
117+
<p>The plugin API is based off of the ServiceLoader class <i>(Service Provider Interface pattern)</i>. With this in mind to have Recaf load your extensions you will need to declare your plugin classes in the file <span class="code">src/META-INF/services/me.coley.plugin.Plugin</span>. If you do not update this file, your plugin will not be loaded. The existing code in the <a href="https://github.com/Col-E/Recaf-plugin-workspace">workspace example</a> includes this file, but when you rename your plugin name or package do remember to update the service file.</p>
118+
<h1 id="examples">Examples</h1>
114119
<p>For examples implmentations of the plugin api check out these sample plugins:</p>
115120
<ul>
116121
<li><a href="plugins-ex-pksize.html">Package Sizes</a></li>

0 commit comments

Comments
 (0)