Skip to content

Commit ca60743

Browse files
LexicalityLexicality
committed
Add a link to get from the docs back to the github repo
1 parent 8d9fa8d commit ca60743

File tree

3 files changed

+61
-63
lines changed

3 files changed

+61
-63
lines changed

‎docs/index.html‎

Lines changed: 58 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ <h1>GMod Sentry</h1>
3030
<h2>Contents</h2>
3131
<ul>
3232
<li><a href="#Functions">Functions</a></li>
33+
<li><a href="#Tables">Tables</a></li>
3334
<li><a href="#util">util</a></li>
34-
<li><a href="#Module_Detection">Module Detection</a></li>
3535
<li><a href="#Transactions">Transactions</a></li>
3636
</ul>
3737

@@ -51,9 +51,7 @@ <h2>Topics</h2>
5151

5252
<h1>Module <code>sentry</code></h1>
5353
<p>Provides an interface to <a href="https://sentry.io">Sentry</a> from GLua</p>
54-
<p>
55-
56-
</p>
54+
<p> <a href="https://github.com/lexicality/gmod-sentry/">Github Page</a></p>
5755
<h3>Info:</h3>
5856
<ul>
5957
<li><strong>Copyright</strong>: 2018 Lex Robinson</li>
@@ -82,26 +80,26 @@ <h2><a href="#Functions">Functions</a></h2>
8280
<td class="summary">Configures and activates Sentry</td>
8381
</tr>
8482
</table>
85-
<h2><a href="#util">util</a></h2>
83+
<h2><a href="#Tables">Tables</a></h2>
8684
<table class="function_list">
8785
<tr>
88-
<td class="name" nowrap><a href="#ISODate">ISODate (time)</a></td>
89-
<td class="summary">Generates an ISO 8601/RFC 6350 formatted date</td>
86+
<td class="name" nowrap><a href="#DetectedModules">DetectedModules</a></td>
87+
<td class="summary">All the modules Sentry has detected.</td>
9088
</tr>
9189
<tr>
92-
<td class="name" nowrap><a href="#GetOSName">GetOSName ()</a></td>
93-
<td class="summary">Generates a pretty printed name of the current operating sytem</td>
90+
<td class="name" nowrap><a href="#DetectionFuncs">DetectionFuncs</a></td>
91+
<td class="summary">More complex ways of detecting a module's version</td>
9492
</tr>
9593
</table>
96-
<h2><a href="#Module_Detection">Module Detection</a></h2>
94+
<h2><a href="#util">util</a></h2>
9795
<table class="function_list">
9896
<tr>
99-
<td class="name" nowrap><a href="#DetectedModules">DetectedModules</a></td>
100-
<td class="summary">All the modules Sentry has detected.</td>
97+
<td class="name" nowrap><a href="#ISODate">ISODate (time)</a></td>
98+
<td class="summary">Generates an ISO 8601/RFC 6350 formatted date</td>
10199
</tr>
102100
<tr>
103-
<td class="name" nowrap><a href="#DetectionFuncs">DetectionFuncs</a></td>
104-
<td class="summary">More complex ways of detecting a module's version</td>
101+
<td class="name" nowrap><a href="#GetOSName">GetOSName ()</a></td>
102+
<td class="summary">Generates a pretty printed name of the current operating sytem</td>
105103
</tr>
106104
</table>
107105
<h2><a href="#Transactions">Transactions</a></h2>
@@ -282,100 +280,100 @@ <h3>Usage:</h3>
282280

283281
</dd>
284282
</dl>
285-
<h2 class="section-header "><a name="util"></a>util</h2>
283+
<h2 class="section-header "><a name="Tables"></a>Tables</h2>
286284

287285
<dl class="function">
288286
<dt>
289-
<a name = "ISODate"></a>
290-
<strong>ISODate (time)</strong>
287+
<a name = "DetectedModules"></a>
288+
<strong>DetectedModules</strong>
291289
</dt>
292290
<dd>
293-
Generates an ISO 8601/RFC 6350 formatted date
294-
291+
All the modules Sentry has detected.
292+
Anything added to this will also be sent to Sentry
295293

296-
<h3>Parameters:</h3>
297-
<ul>
298-
<li><span class="parameter">time</span>
299-
The unix timestamp to generate the date from
300-
</li>
301-
</ul>
302294

303-
<h3>Returns:</h3>
304-
<ol>
305295

306-
The date string
307-
</ol>
308296

309297

310298

299+
<h3>Usage:</h3>
300+
<ul>
301+
<pre class="example">sentry.DetectedModules[<span class="string">"foo"</span>] = <span class="string">"7.2"</span></pre>
302+
</ul>
311303

312304
</dd>
313305
<dt>
314-
<a name = "GetOSName"></a>
315-
<strong>GetOSName ()</strong>
306+
<a name = "DetectionFuncs"></a>
307+
<strong>DetectionFuncs</strong>
316308
</dt>
317309
<dd>
318-
Generates a pretty printed name of the current operating sytem
310+
More complex ways of detecting a module's version
319311

320312

313+
<h3>Fields:</h3>
314+
<ul>
315+
<li><span class="parameter">_</span>
321316

322-
<h3>Returns:</h3>
323-
<ol>
324317

325-
"Windows", "macOS", "Linux" or nil.
326-
</ol>
318+
319+
</li>
320+
</ul>
327321

328322

329323

330324

325+
<h3>Usage:</h3>
326+
<ul>
327+
<pre class="example">sentry.DetectionFuncs[<span class="string">"global name"</span>] = <span class="keyword">function</span>(global_value) <span class="keyword">return</span> <span class="string">"version"</span>, <span class="string">"optional override name"</span> <span class="keyword">end</span></pre>
328+
</ul>
329+
331330
</dd>
332331
</dl>
333-
<h2 class="section-header "><a name="Module_Detection"></a>Module Detection</h2>
332+
<h2 class="section-header "><a name="util"></a>util</h2>
334333

335334
<dl class="function">
336335
<dt>
337-
<a name = "DetectedModules"></a>
338-
<strong>DetectedModules</strong>
336+
<a name = "ISODate"></a>
337+
<strong>ISODate (time)</strong>
339338
</dt>
340339
<dd>
341-
All the modules Sentry has detected.
342-
Anything added to this will also be sent to Sentry
340+
Generates an ISO 8601/RFC 6350 formatted date
343341

344342

343+
<h3>Parameters:</h3>
344+
<ul>
345+
<li><span class="parameter">time</span>
346+
The unix timestamp to generate the date from
347+
</li>
348+
</ul>
345349

350+
<h3>Returns:</h3>
351+
<ol>
352+
353+
The date string
354+
</ol>
346355

347356

348357

349-
<h3>Usage:</h3>
350-
<ul>
351-
<pre class="example">sentry.DetectedModules[<span class="string">"foo"</span>] = <span class="string">"7.2"</span></pre>
352-
</ul>
353358

354359
</dd>
355360
<dt>
356-
<a name = "DetectionFuncs"></a>
357-
<strong>DetectionFuncs</strong>
361+
<a name = "GetOSName"></a>
362+
<strong>GetOSName ()</strong>
358363
</dt>
359364
<dd>
360-
More complex ways of detecting a module's version
361-
362-
363-
<h3>Fields:</h3>
364-
<ul>
365-
<li><span class="parameter">_</span>
365+
Generates a pretty printed name of the current operating sytem
366366

367367

368368

369-
</li>
370-
</ul>
369+
<h3>Returns:</h3>
370+
<ol>
371371

372+
"Windows", "macOS", "Linux" or nil.
373+
</ol>
372374

373375

374376

375-
<h3>Usage:</h3>
376-
<ul>
377-
<pre class="example">sentry.DetectionFuncs[<span class="string">"global name"</span>] = <span class="keyword">function</span>(global_value) <span class="keyword">return</span> <span class="string">"version"</span>, <span class="string">"optional override name"</span> <span class="keyword">end</span></pre>
378-
</ul>
379377

380378
</dd>
381379
</dl>
@@ -560,7 +558,7 @@ <h3>Usage:</h3>
560558
</div> <!-- id="main" -->
561559
<div id="about">
562560
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
563-
<i style="float:right;">Last updated 2018-08-19 20:14:22 </i>
561+
<i style="float:right;">Last updated 2018-08-19 20:16:56 </i>
564562
</div> <!-- id="about" -->
565563
</div> <!-- id="container" -->
566564
</body>

‎docs/topics/readme.md.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ <h2>Documentation</h2>
127127
</div> <!-- id="main" -->
128128
<div id="about">
129129
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
130-
<i style="float:right;">Last updated 2018-08-19 20:14:22 </i>
130+
<i style="float:right;">Last updated 2018-08-19 20:16:56 </i>
131131
</div> <!-- id="about" -->
132132
</div> <!-- id="container" -->
133133
</body>

‎lua/includes/modules/sentry.lua‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@
1717

1818
---
1919
-- Provides an interface to [Sentry](https://sentry.io) from GLua
20+
--
21+
-- [Github Page](https://github.com/lexicality/gmod-sentry/)
2022
-- @module sentry
2123
-- @author Lex Robinson
2224
-- @copyright 2018 Lex Robinson
@@ -146,13 +148,11 @@ end
146148
---
147149
-- All the modules Sentry has detected.
148150
-- Anything added to this will also be sent to Sentry
149-
-- @within Module Detection
150151
-- @usage sentry.DetectedModules["foo"] = "7.2"
151152
DetectedModules = {};
152153

153154
---
154155
-- More complex ways of detecting a module's version
155-
-- @within Module Detection
156156
-- @field _
157157
-- @usage sentry.DetectionFuncs["global name"] = function(global_value) return "version", "optional override name" end
158158
DetectionFuncs = {

0 commit comments

Comments
 (0)