Skip to content

Commit c50f658

Browse files
Nan1tNan1t
committed
Updated docs
1 parent 0b7ba76 commit c50f658

5 files changed

Lines changed: 66 additions & 6 deletions

File tree

‎docs/index-all.html‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -371,6 +371,8 @@ <h2 class="title">G</h2>
371371
<dd>
372372
<div class="block">Get token to deserialize catalog from menu file</div>
373373
</dd>
374+
<dt><span class="memberNameLink"><a href="ru/abstractmenus/hocon/api/serialize/NodeSerializeException.html#getCauseNode--">getCauseNode()</a></span> - Method in exception ru.abstractmenus.hocon.api.serialize.<a href="ru/abstractmenus/hocon/api/serialize/NodeSerializeException.html" title="class in ru.abstractmenus.hocon.api.serialize">NodeSerializeException</a></dt>
375+
<dd>&nbsp;</dd>
374376
<dt><span class="memberNameLink"><a href="ru/abstractmenus/api/inventory/Menu.html#getContext--">getContext()</a></span> - Method in interface ru.abstractmenus.api.inventory.<a href="ru/abstractmenus/api/inventory/Menu.html" title="interface in ru.abstractmenus.api.inventory">Menu</a></dt>
375377
<dd>
376378
<div class="block">Get activation context object.</div>
@@ -568,7 +570,9 @@ <h2 class="title">G</h2>
568570
<div class="block">Get deserialized value</div>
569571
</dd>
570572
<dt><span class="memberNameLink"><a href="ru/abstractmenus/api/Activator.html#getValueExtractor--">getValueExtractor()</a></span> - Method in class ru.abstractmenus.api.<a href="ru/abstractmenus/api/Activator.html" title="class in ru.abstractmenus.api">Activator</a></dt>
571-
<dd>&nbsp;</dd>
573+
<dd>
574+
<div class="block">Get value extractor for this activator.</div>
575+
</dd>
572576
<dt><span class="memberNameLink"><a href="ru/abstractmenus/api/AbstractMenusPlugin.html#getVariableManager--">getVariableManager()</a></span> - Method in interface ru.abstractmenus.api.<a href="ru/abstractmenus/api/AbstractMenusPlugin.html" title="interface in ru.abstractmenus.api">AbstractMenusPlugin</a></dt>
573577
<dd>
574578
<div class="block">Get variables manager</div>

‎docs/ru/abstractmenus/api/Activator.html‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,9 @@ <h3>Method Summary</h3>
174174
</tr>
175175
<tr id="i0" class="altColor">
176176
<td class="colFirst"><code><a href="../../../ru/abstractmenus/api/ValueExtractor.html" title="interface in ru.abstractmenus.api">ValueExtractor</a></code></td>
177-
<td class="colLast"><code><span class="memberNameLink"><a href="../../../ru/abstractmenus/api/Activator.html#getValueExtractor--">getValueExtractor</a></span>()</code>&nbsp;</td>
177+
<td class="colLast"><code><span class="memberNameLink"><a href="../../../ru/abstractmenus/api/Activator.html#getValueExtractor--">getValueExtractor</a></span>()</code>
178+
<div class="block">Get value extractor for this activator.</div>
179+
</td>
178180
</tr>
179181
<tr id="i1" class="rowColor">
180182
<td class="colFirst"><code>protected void</code></td>
@@ -283,6 +285,11 @@ <h4>openMenu</h4>
283285
<li class="blockList">
284286
<h4>getValueExtractor</h4>
285287
<pre>public&nbsp;<a href="../../../ru/abstractmenus/api/ValueExtractor.html" title="interface in ru.abstractmenus.api">ValueExtractor</a>&nbsp;getValueExtractor()</pre>
288+
<div class="block">Get value extractor for this activator. Can be null</div>
289+
<dl>
290+
<dt><span class="returnLabel">Returns:</span></dt>
291+
<dd>ValueExtractor instance</dd>
292+
</dl>
286293
</li>
287294
</ul>
288295
</li>

‎docs/ru/abstractmenus/hocon/api/serialize/NodeSerializeException.html‎

Lines changed: 38 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,12 @@
1717
catch(err) {
1818
}
1919
//-->
20+
var methods = {"i0":10};
21+
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
22+
var altColor = "altColor";
23+
var rowColor = "rowColor";
24+
var tableTab = "tableTab";
25+
var activeTableTab = "activeTableTab";
2026
</script>
2127
<noscript>
2228
<div>JavaScript is disabled on your browser.</div>
@@ -69,13 +75,13 @@
6975
<li>Nested&nbsp;|&nbsp;</li>
7076
<li>Field&nbsp;|&nbsp;</li>
7177
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
72-
<li><a href="#methods.inherited.from.class.java.lang.Throwable">Method</a></li>
78+
<li><a href="#method.summary">Method</a></li>
7379
</ul>
7480
<ul class="subNavList">
7581
<li>Detail:&nbsp;</li>
7682
<li>Field&nbsp;|&nbsp;</li>
7783
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
78-
<li>Method</li>
84+
<li><a href="#method.detail">Method</a></li>
7985
</ul>
8086
</div>
8187
<a name="skip.navbar.top">
@@ -161,6 +167,17 @@ <h3>Constructor Summary</h3>
161167
<!-- -->
162168
</a>
163169
<h3>Method Summary</h3>
170+
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
171+
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
172+
<tr>
173+
<th class="colFirst" scope="col">Modifier and Type</th>
174+
<th class="colLast" scope="col">Method and Description</th>
175+
</tr>
176+
<tr id="i0" class="altColor">
177+
<td class="colFirst"><code><a href="../../../../../ru/abstractmenus/hocon/api/ConfigNode.html" title="interface in ru.abstractmenus.hocon.api">ConfigNode</a></code></td>
178+
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../ru/abstractmenus/hocon/api/serialize/NodeSerializeException.html#getCauseNode--">getCauseNode</a></span>()</code>&nbsp;</td>
179+
</tr>
180+
</table>
164181
<ul class="blockList">
165182
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Throwable">
166183
<!-- -->
@@ -229,6 +246,23 @@ <h4>NodeSerializeException</h4>
229246
</ul>
230247
</li>
231248
</ul>
249+
<!-- ============ METHOD DETAIL ========== -->
250+
<ul class="blockList">
251+
<li class="blockList"><a name="method.detail">
252+
<!-- -->
253+
</a>
254+
<h3>Method Detail</h3>
255+
<a name="getCauseNode--">
256+
<!-- -->
257+
</a>
258+
<ul class="blockListLast">
259+
<li class="blockList">
260+
<h4>getCauseNode</h4>
261+
<pre>public&nbsp;<a href="../../../../../ru/abstractmenus/hocon/api/ConfigNode.html" title="interface in ru.abstractmenus.hocon.api">ConfigNode</a>&nbsp;getCauseNode()</pre>
262+
</li>
263+
</ul>
264+
</li>
265+
</ul>
232266
</li>
233267
</ul>
234268
</div>
@@ -282,13 +316,13 @@ <h4>NodeSerializeException</h4>
282316
<li>Nested&nbsp;|&nbsp;</li>
283317
<li>Field&nbsp;|&nbsp;</li>
284318
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
285-
<li><a href="#methods.inherited.from.class.java.lang.Throwable">Method</a></li>
319+
<li><a href="#method.summary">Method</a></li>
286320
</ul>
287321
<ul class="subNavList">
288322
<li>Detail:&nbsp;</li>
289323
<li>Field&nbsp;|&nbsp;</li>
290324
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
291-
<li>Method</li>
325+
<li><a href="#method.detail">Method</a></li>
292326
</ul>
293327
</div>
294328
<a name="skip.navbar.bottom">

‎docs/serialized-form.html‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,17 @@ <h2 title="Package">Package&nbsp;ru.abstractmenus.hocon.api.serialize</h2>
7979
<!-- -->
8080
</a>
8181
<h3>Class <a href="ru/abstractmenus/hocon/api/serialize/NodeSerializeException.html" title="class in ru.abstractmenus.hocon.api.serialize">ru.abstractmenus.hocon.api.serialize.NodeSerializeException</a> extends java.lang.Exception implements Serializable</h3>
82+
<ul class="blockList">
83+
<li class="blockList">
84+
<h3>Serialized Fields</h3>
85+
<ul class="blockList">
86+
<li class="blockListLast">
87+
<h4>causeNode</h4>
88+
<pre><a href="ru/abstractmenus/hocon/api/ConfigNode.html" title="interface in ru.abstractmenus.hocon.api">ConfigNode</a> causeNode</pre>
89+
</li>
90+
</ul>
91+
</li>
92+
</ul>
8293
</li>
8394
</ul>
8495
</li>

‎src/main/java/ru/abstractmenus/api/Activator.java‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,10 @@ protected void openMenu(Object ctx, Player player) {
3232
AbstractMenusProvider.get().openMenu(this, ctx, player, menu);
3333
}
3434

35+
/**
36+
* Get value extractor for this activator. Can be null
37+
* @return ValueExtractor instance
38+
*/
3539
public ValueExtractor getValueExtractor() {
3640
return null;
3741
}

0 commit comments

Comments
 (0)