Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Slice: Add generated slice HTML documentation 1.2.0, 1.2.7, 1.3.0 #76

Merged
merged 1 commit into from
Oct 27, 2019
+17,030 −0
Merged

Slice: Add generated slice HTML documentation 1.2.0, 1.2.7, 1.3.0 #76

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
764 changes: 764 additions & 0 deletions hugo/static/documentation/slice/1.2.0/Murmur.ice
View file
Open in desktop

Large diffs are not rendered by default.

703 changes: 703 additions & 0 deletions hugo/static/documentation/slice/1.2.0/html/Murmur.html
View file
Open in desktop

Large diffs are not rendered by default.

125 changes: 125 additions & 0 deletions hugo/static/documentation/slice/1.2.0/html/Murmur/ACL.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
<!-- Generated by Ice version 3.6.5 -->

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<title>
Murmur::ACL
</title>
</head>
<body>
<!-- SwishCommand noindex -->
<table class="HeaderFooter">
<tr>
<td align="left">
<table>
<tr>
<td><a href="../index.html">Home</a></td>
<td><a href="../Murmur.html">Previous</a></td>
<td><a href="../Murmur.html">Up</a></td>
<td><a href="../Murmur/Ban.html">Next</a></td>
<td><a href="../_sindex.html">Index</a></td>
</tr>
</table>
</td>
<td align="center"></td>
<td align="right"></td>
</tr>
</table>
<!-- SwishCommand index -->

<hr>
<h1 class="Symbol">Murmur::ACL</h1>
<h2>Overview</h2>
<h3 class="Synopsis">struct ACL</h3>
<p>
Access Control List for a channel. ACLs are defined per channel, and can be inherited from parent channels.</p>
<h4>Used By</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="../Murmur.html#ACLList">ACLList</a></dt>
</dl>
<h2>Data Member Index</h2>
<dl>
<dt class="Symbol"><a class="Symbol" href="../Murmur/ACL.html#applyHere">applyHere</a></dt>
<dd>
Does the ACL apply to this channel?</dd>
<dt class="Symbol"><a class="Symbol" href="../Murmur/ACL.html#applySubs">applySubs</a></dt>
<dd>
Does the ACL apply to subchannels?</dd>
<dt class="Symbol"><a class="Symbol" href="../Murmur/ACL.html#inherited">inherited</a></dt>
<dd>
Is this ACL inherited from a parent channel? Read-only.</dd>
<dt class="Symbol"><a class="Symbol" href="../Murmur/ACL.html#userid">userid</a></dt>
<dd>
ID of user this ACL applies to.</dd>
<dt class="Symbol"><a class="Symbol" href="../Murmur/ACL.html#group">group</a></dt>
<dd>
Group this ACL applies to.</dd>
<dt class="Symbol"><a class="Symbol" href="../Murmur/ACL.html#allow">allow</a></dt>
<dd>
Binary mask of privileges to allow.</dd>
<dt class="Symbol"><a class="Symbol" href="../Murmur/ACL.html#deny">deny</a></dt>
<dd>
Binary mask of privileges to deny.</dd>
</dl>
<h2>Data Members</h2>
<dl>
<dt class="Symbol"><a name="applyHere"/>bool applyHere;</dt>
<dd>
<p>
Does the ACL apply to this channel?</p>
</dd>
<dt class="Symbol"><a name="applySubs"/>bool applySubs;</dt>
<dd>
<p>
Does the ACL apply to subchannels?</p>
</dd>
<dt class="Symbol"><a name="inherited"/>bool inherited;</dt>
<dd>
<p>
Is this ACL inherited from a parent channel? Read-only.</p>
</dd>
<dt class="Symbol"><a name="userid"/>int userid;</dt>
<dd>
<p>
ID of user this ACL applies to. -1 if using a group name.</p>
</dd>
<dt class="Symbol"><a name="group"/>string group;</dt>
<dd>
<p>
Group this ACL applies to. Blank if using userid.</p>
</dd>
<dt class="Symbol"><a name="allow"/>int allow;</dt>
<dd>
<p>
Binary mask of privileges to allow.</p>
</dd>
<dt class="Symbol"><a name="deny"/>int deny;</dt>
<dd>
<p>
Binary mask of privileges to deny.</p>
</dd>
</dl>
<hr>
<!-- SwishCommand noindex -->
<table class="HeaderFooter">
<tr>
<td align="left">
<table>
<tr>
<td><a href="../index.html">Home</a></td>
<td><a href="../Murmur.html">Previous</a></td>
<td><a href="../Murmur.html">Up</a></td>
<td><a href="../Murmur/Ban.html">Next</a></td>
<td><a href="../_sindex.html">Index</a></td>
</tr>
</table>
</td>
<td align="center"></td>
<td align="right"></td>
</tr>
</table>
<!-- SwishCommand index -->

</body>
</html>
125 changes: 125 additions & 0 deletions hugo/static/documentation/slice/1.2.0/html/Murmur/Ban.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
<!-- Generated by Ice version 3.6.5 -->

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<title>
Murmur::Ban
</title>
</head>
<body>
<!-- SwishCommand noindex -->
<table class="HeaderFooter">
<tr>
<td align="left">
<table>
<tr>
<td><a href="../index.html">Home</a></td>
<td><a href="../Murmur/ACL.html">Previous</a></td>
<td><a href="../Murmur.html">Up</a></td>
<td><a href="../Murmur/Channel.html">Next</a></td>
<td><a href="../_sindex.html">Index</a></td>
</tr>
</table>
</td>
<td align="center"></td>
<td align="right"></td>
</tr>
</table>
<!-- SwishCommand index -->

<hr>
<h1 class="Symbol">Murmur::Ban</h1>
<h2>Overview</h2>
<h3 class="Synopsis">struct Ban</h3>
<p>
A single ip mask for a ban.</p>
<h4>Used By</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="../Murmur.html#BanList">BanList</a></dt>
</dl>
<h2>Data Member Index</h2>
<dl>
<dt class="Symbol"><a class="Symbol" href="../Murmur/Ban.html#address">address</a></dt>
<dd>
Address to ban.</dd>
<dt class="Symbol"><a class="Symbol" href="../Murmur/Ban.html#bits">bits</a></dt>
<dd>
Number of bits in ban to apply.</dd>
<dt class="Symbol"><a class="Symbol" href="../Murmur/Ban.html#name">name</a></dt>
<dd>
Username associated with ban.</dd>
<dt class="Symbol"><a class="Symbol" href="../Murmur/Ban.html#hash">hash</a></dt>
<dd>
Hash of banned user.</dd>
<dt class="Symbol"><a class="Symbol" href="../Murmur/Ban.html#reason">reason</a></dt>
<dd>
Reason for ban.</dd>
<dt class="Symbol"><a class="Symbol" href="../Murmur/Ban.html#start">start</a></dt>
<dd>
Date ban was applied in unix time format.</dd>
<dt class="Symbol"><a class="Symbol" href="../Murmur/Ban.html#duration">duration</a></dt>
<dd>
Duration of ban.</dd>
</dl>
<h2>Data Members</h2>
<dl>
<dt class="Symbol"><a name="address"/><a class="Symbol" href="../Murmur.html#NetAddress">NetAddress</a> address;</dt>
<dd>
<p>
Address to ban.</p>
</dd>
<dt class="Symbol"><a name="bits"/>int bits;</dt>
<dd>
<p>
Number of bits in ban to apply.</p>
</dd>
<dt class="Symbol"><a name="name"/>string name;</dt>
<dd>
<p>
Username associated with ban.</p>
</dd>
<dt class="Symbol"><a name="hash"/>string hash;</dt>
<dd>
<p>
Hash of banned user.</p>
</dd>
<dt class="Symbol"><a name="reason"/>string reason;</dt>
<dd>
<p>
Reason for ban.</p>
</dd>
<dt class="Symbol"><a name="start"/>long start;</dt>
<dd>
<p>
Date ban was applied in unix time format.</p>
</dd>
<dt class="Symbol"><a name="duration"/>int duration;</dt>
<dd>
<p>
Duration of ban.</p>
</dd>
</dl>
<hr>
<!-- SwishCommand noindex -->
<table class="HeaderFooter">
<tr>
<td align="left">
<table>
<tr>
<td><a href="../index.html">Home</a></td>
<td><a href="../Murmur/ACL.html">Previous</a></td>
<td><a href="../Murmur.html">Up</a></td>
<td><a href="../Murmur/Channel.html">Next</a></td>
<td><a href="../_sindex.html">Index</a></td>
</tr>
</table>
</td>
<td align="center"></td>
<td align="right"></td>
</tr>
</table>
<!-- SwishCommand index -->

</body>
</html>
132 changes: 132 additions & 0 deletions hugo/static/documentation/slice/1.2.0/html/Murmur/Channel.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
<!-- Generated by Ice version 3.6.5 -->

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<title>
Murmur::Channel
</title>
</head>
<body>
<!-- SwishCommand noindex -->
<table class="HeaderFooter">
<tr>
<td align="left">
<table>
<tr>
<td><a href="../index.html">Home</a></td>
<td><a href="../Murmur/Ban.html">Previous</a></td>
<td><a href="../Murmur.html">Up</a></td>
<td><a href="../Murmur/ChannelInfo.html">Next</a></td>
<td><a href="../_sindex.html">Index</a></td>
</tr>
</table>
</td>
<td align="center"></td>
<td align="right"></td>
</tr>
</table>
<!-- SwishCommand index -->

<hr>
<h1 class="Symbol">Murmur::Channel</h1>
<h2>Overview</h2>
<h3 class="Synopsis">struct Channel</h3>
<p>
A channel.</p>
<h4>Used By</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="../Murmur.html#ChannelList">ChannelList</a></dt>
<dt class="Symbol"><a class="Symbol" href="../Murmur.html#ChannelMap">ChannelMap</a></dt>
<dt class="Symbol"><a class="Symbol" href="../Murmur/Server.html#getChannelState">Server::getChannelState</a></dt>
<dt class="Symbol"><a class="Symbol" href="../Murmur/Server.html#setChannelState">Server::setChannelState</a></dt>
<dt class="Symbol"><a class="Symbol" href="../Murmur/ServerCallback.html#channelCreated">ServerCallback::channelCreated</a></dt>
<dt class="Symbol"><a class="Symbol" href="../Murmur/ServerCallback.html#channelRemoved">ServerCallback::channelRemoved</a></dt>
<dt class="Symbol"><a class="Symbol" href="../Murmur/ServerCallback.html#channelStateChanged">ServerCallback::channelStateChanged</a></dt>
<dt class="Symbol"><a class="Symbol" href="../Murmur/Tree.html#c">Tree::c</a></dt>
</dl>
<h2>Data Member Index</h2>
<dl>
<dt class="Symbol"><a class="Symbol" href="../Murmur/Channel.html#id">id</a></dt>
<dd>
Channel ID.</dd>
<dt class="Symbol"><a class="Symbol" href="../Murmur/Channel.html#name">name</a></dt>
<dd>
Name of the channel.</dd>
<dt class="Symbol"><a class="Symbol" href="../Murmur/Channel.html#parent">parent</a></dt>
<dd>
ID of parent channel, or -1 if this is the root channel.</dd>
<dt class="Symbol"><a class="Symbol" href="../Murmur/Channel.html#links">links</a></dt>
<dd>
List of id of linked channels.</dd>
<dt class="Symbol"><a class="Symbol" href="../Murmur/Channel.html#description">description</a></dt>
<dd>
Description of channel.</dd>
<dt class="Symbol"><a class="Symbol" href="../Murmur/Channel.html#temporary">temporary</a></dt>
<dd>
Channel is temporary, and will be removed when the last user leaves it.</dd>
<dt class="Symbol"><a class="Symbol" href="../Murmur/Channel.html#position">position</a></dt>
<dd>
Position of the channel which is used in Client for sorting.</dd>
</dl>
<h2>Data Members</h2>
<dl>
<dt class="Symbol"><a name="id"/>int id;</dt>
<dd>
<p>
Channel ID. This is unique per channel, and the root channel is always id 0.</p>
</dd>
<dt class="Symbol"><a name="name"/>string name;</dt>
<dd>
<p>
Name of the channel. There can not be two channels with the same parent that has the same name.</p>
</dd>
<dt class="Symbol"><a name="parent"/>int parent;</dt>
<dd>
<p>
ID of parent channel, or -1 if this is the root channel.</p>
</dd>
<dt class="Symbol"><a name="links"/><a class="Symbol" href="../Murmur.html#IntList">IntList</a> links;</dt>
<dd>
<p>
List of id of linked channels.</p>
</dd>
<dt class="Symbol"><a name="description"/>string description;</dt>
<dd>
<p>
Description of channel. Shown as tooltip for this channel.</p>
</dd>
<dt class="Symbol"><a name="temporary"/>bool temporary;</dt>
<dd>
<p>
Channel is temporary, and will be removed when the last user leaves it.</p>
</dd>
<dt class="Symbol"><a name="position"/>int position;</dt>
<dd>
<p>
Position of the channel which is used in Client for sorting.</p>
</dd>
</dl>
<hr>
<!-- SwishCommand noindex -->
<table class="HeaderFooter">
<tr>
<td align="left">
<table>
<tr>
<td><a href="../index.html">Home</a></td>
<td><a href="../Murmur/Ban.html">Previous</a></td>
<td><a href="../Murmur.html">Up</a></td>
<td><a href="../Murmur/ChannelInfo.html">Next</a></td>
<td><a href="../_sindex.html">Index</a></td>
</tr>
</table>
</td>
<td align="center"></td>
<td align="right"></td>
</tr>
</table>
<!-- SwishCommand index -->

</body>
</html>
Loading