Skip to content

Commit

Permalink
docs: 📝 Updated API Docs for 3.0.1
Browse files Browse the repository at this point in the history
  • Loading branch information
@maicol07
maicol07 committed May 22, 2021
1 parent cc6539e commit 30734d1
Show file tree
Hide file tree
Showing 8 changed files with 219 additions and 69 deletions.
2 changes: 0 additions & 2 deletions .idea/vcs.xml
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

69 changes: 36 additions & 33 deletions docs/Maicol07/SSO/Addons/Groups.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,13 @@ <h1 class="flarum-title navbar-brand"></h1>
<li class="nav-item"><a class="nav-link" href="https://flarum.org">Flarum</a></li>
<li class="nav-item"><a class="nav-link"
href="https://discuss.flarum.org/d/21666-php-and-wordpress-single-sign-on-sso"
target="_blank">Thread</a></li>
target="_blank">Thread</a>
</li>
<li class="nav-item"><a class="nav-link" href="https://docs.maicol07.it/en/flarum-sso/plugins/php"
target="_blank">Docs</a></li>
<li class="nav-item"><a class="nav-link icon icon-github-circled"
href="https://github.com/maicol07/flarum-sso-php-plugin" target="_blank"></a>
</li>
href="https://github.com/maicol07/flarum-sso-php-plugin"
target="_blank"></a></li>
</ul>
</div>
</nav>
Expand Down Expand Up @@ -96,7 +97,7 @@ <h2>Properties</h2>
<td><small>from&nbsp;<a href="../../../Maicol07/SSO/Addons/Core.html#property_hooks"><abbr
title="Maicol07\SSO\Addons\Core">Core</abbr></a></small></td>
<td width="24px"><a
href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/Addons/Groups.php#L14"
href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/Addons/Groups.php#L15"
target="_blank">
<img alt="See the code on Github" height="18" src="../../../assets/img/code.svg"/>
</a>
Expand Down Expand Up @@ -125,36 +126,37 @@ <h2>Properties</h2>
<td><small>from&nbsp;<a href="../../../Maicol07/SSO/Addons/Core.html#property_filters"><abbr
title="Maicol07\SSO\Addons\Core">Core</abbr></a></small></td>
<td width="24px"><a
href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/Addons/Groups.php#L20"
href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/Addons/Groups.php#L21"
target="_blank">
<img alt="See the code on Github" height="18" src="../../../assets/img/code.svg"/>
</a>
</td>
</tr>
<tr>
<td class="type" id="property_flarum">
<td class="type" id="property_required">
protected
</td>
<td>$flarum</td>
<td>$required</td>
<td class="last"></td>
<td><small>from&nbsp;<a href="../../../Maicol07/SSO/Addons/Core.html#property_flarum"><abbr
<td><small>from&nbsp;<a href="../../../Maicol07/SSO/Addons/Core.html#property_required"><abbr
title="Maicol07\SSO\Addons\Core">Core</abbr></a></small></td>
<td width="24px"><a
href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/Addons/Groups.php#L23"
href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/Addons/Groups.php#L24"
target="_blank">
<img alt="See the code on Github" height="18" src="../../../assets/img/code.svg"/>
</a>
</td>
</tr>
<tr>
<td class="type" id="property_set_groups_admins">

<td class="type" id="property_flarum">
protected
</td>
<td>$set_groups_admins</td>
<td>$flarum</td>
<td class="last"></td>
<td></td>
<td><small>from&nbsp;<a href="../../../Maicol07/SSO/Addons/Core.html#property_flarum"><abbr
title="Maicol07\SSO\Addons\Core">Core</abbr></a></small></td>
<td width="24px"><a
href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/Addons/Groups.php#L18"
href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/Addons/Groups.php#L27"
target="_blank">
<img alt="See the code on Github" height="18" src="../../../assets/img/code.svg"/>
</a>
Expand All @@ -181,7 +183,7 @@ <h2>Methods</h2>
href="../../../Maicol07/SSO/Addons/Core.html#method___construct"><abbr
title="Maicol07\SSO\Addons\Core">Core</abbr></a></small></div>
<div class="col-md-2 text-right" style="padding-right: 5px;">
<a href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/Addons/Groups.php#L25"
<a href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/Addons/Groups.php#L29"
target="_blank">
<img alt="See the code on Github" height="18" src="../../../assets/img/code.svg"/>
</a>
Expand All @@ -202,7 +204,7 @@ <h2>Methods</h2>
href="../../../Maicol07/SSO/Addons/Core.html#method_load"><abbr
title="Maicol07\SSO\Addons\Core">Core</abbr></a></small></div>
<div class="col-md-2 text-right" style="padding-right: 5px;">
<a href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/Addons/Groups.php#L37"
<a href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/Addons/Groups.php#L41"
target="_blank">
<img alt="See the code on Github" height="18" src="../../../assets/img/code.svg"/>
</a>
Expand All @@ -223,7 +225,7 @@ <h2>Methods</h2>
href="../../../Maicol07/SSO/Addons/Core.html#method_unload"><abbr
title="Maicol07\SSO\Addons\Core">Core</abbr></a></small></div>
<div class="col-md-2 text-right" style="padding-right: 5px;">
<a href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/Addons/Groups.php#L65"
<a href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/Addons/Groups.php#L80"
target="_blank">
<img alt="See the code on Github" height="18" src="../../../assets/img/code.svg"/>
</a>
Expand All @@ -240,7 +242,7 @@ <h2>Methods</h2>
<p>Sets groups to a user</p></div>
<div class="col-md-2"></div>
<div class="col-md-2 text-right" style="padding-right: 5px;">
<a href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/Addons/Groups.php#L24"
<a href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/Addons/Groups.php#L21"
target="_blank">
<img alt="See the code on Github" height="18" src="../../../assets/img/code.svg"/>
</a>
Expand All @@ -258,7 +260,7 @@ <h2>Methods</h2>
</div>
<div class="col-md-2"></div>
<div class="col-md-2 text-right" style="padding-right: 5px;">
<a href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/Addons/Groups.php#L77"
<a href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/Addons/Groups.php#L73"
target="_blank">
<img alt="See the code on Github" height="18" src="../../../assets/img/code.svg"/>
</a>
Expand All @@ -277,9 +279,9 @@ <h3 id="method___construct">
in <a href="../../../Maicol07/SSO/Addons/Core.html#method___construct"><abbr
title="Maicol07\SSO\Addons\Core">Core</abbr></a>
at <a
href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/SSO/Addons/Core.php#L25"
href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/SSO/Addons/Core.php#L29"
target="_blank">
line 25
line 29
</a>
</div>
<code>
Expand Down Expand Up @@ -319,9 +321,9 @@ <h3 id="method_load">
in <a href="../../../Maicol07/SSO/Addons/Core.html#method_load"><abbr
title="Maicol07\SSO\Addons\Core">Core</abbr></a>
at <a
href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/SSO/Addons/Core.php#L37"
href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/SSO/Addons/Core.php#L41"
target="_blank">
line 37
line 41
</a>
</div>
<code> <a href="../../../Maicol07/SSO/Addons/Core.html"><abbr
Expand Down Expand Up @@ -355,9 +357,9 @@ <h3 id="method_unload">
in <a href="../../../Maicol07/SSO/Addons/Core.html#method_unload"><abbr
title="Maicol07\SSO\Addons\Core">Core</abbr></a>
at <a
href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/SSO/Addons/Core.php#L65"
href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/SSO/Addons/Core.php#L80"
target="_blank">
line 65
line 80
</a>
</div>
<code> <a href="../../../Maicol07/SSO/Addons/Core.html"><abbr
Expand Down Expand Up @@ -389,9 +391,9 @@ <h4>Return Value</h4>
<h3 id="method_setGroups">
<div class="location">
at <a
href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/SSO/Addons/Groups.php#L24"
href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/SSO/Addons/Groups.php#L21"
target="_blank">
line 24
line 21
</a>
</div>
<code> void
Expand Down Expand Up @@ -423,9 +425,9 @@ <h4>Return Value</h4>
<h3 id="method_createGroup">
<div class="location">
at <a
href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/SSO/Addons/Groups.php#L77"
href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/SSO/Addons/Groups.php#L73"
target="_blank">
line 77
line 73
</a>
</div>
<code>
Expand Down Expand Up @@ -457,11 +459,12 @@ <h4>Parameters</h4>
</div>
<div id="footer">
<p>Generated by <a href="https://github.com/code-lts/doctum">Doctum, a API Documentation generator and
fork of Sami</a>.</p>
fork of
Sami</a>.</p>
<p>Created by <a href="https://github.com/datitisev">@datitisev</a>. Modified by <a
href="https://maicol07.it">@maicol07</a> (<a href="https://github.com/maicol07">Github</a>).
Source code can be found on <a href="https://github.com/maicol07/flarum-sso-php-plugin">GitHub</a>.
</p>
href="https://maicol07.it">@maicol07</a>
(<a href="https://github.com/maicol07">Github</a>). Source code can be found on <a
href="https://github.com/maicol07/flarum-sso-php-plugin">GitHub</a>.</p>
</div>

</div>
Expand Down
Loading

0 comments on commit 30734d1

Please sign in to comment.