Skip to content

Commit f32e20f

Browse files
larswaechterlarswaechter
committed
Update code comments and docs
1 parent 0ac5593 commit f32e20f

File tree

135 files changed

+2120
-1079
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

135 files changed

+2120
-1079
lines changed

‎docs/assets/js/search.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/classes/announcement.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ <h3>author</h3>
9999
<div class="tsd-signature tsd-kind-icon">author<span class="tsd-signature-symbol">:</span> <a href="user.html" class="tsd-signature-type">User</a></div>
100100
<aside class="tsd-sources">
101101
<ul>
102-
<li>Defined in <a href="https://github.com/Aionic-Apps/aionic-core/blob/5342d02/src/api/components/milestone/announcement/model.ts#L27">api/components/milestone/announcement/model.ts:27</a></li>
102+
<li>Defined in <a href="https://github.com/Aionic-Apps/aionic-core/blob/0ac5593/src/api/components/milestone/announcement/model.ts#L27">api/components/milestone/announcement/model.ts:27</a></li>
103103
</ul>
104104
</aside>
105105
<div class="tsd-comment tsd-typography">
@@ -114,7 +114,7 @@ <h3>created</h3>
114114
<div class="tsd-signature tsd-kind-icon">created<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Timestamp</span></div>
115115
<aside class="tsd-sources">
116116
<ul>
117-
<li>Defined in <a href="https://github.com/Aionic-Apps/aionic-core/blob/5342d02/src/api/components/milestone/announcement/model.ts#L23">api/components/milestone/announcement/model.ts:23</a></li>
117+
<li>Defined in <a href="https://github.com/Aionic-Apps/aionic-core/blob/0ac5593/src/api/components/milestone/announcement/model.ts#L23">api/components/milestone/announcement/model.ts:23</a></li>
118118
</ul>
119119
</aside>
120120
</section>
@@ -124,7 +124,7 @@ <h3>description</h3>
124124
<div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
125125
<aside class="tsd-sources">
126126
<ul>
127-
<li>Defined in <a href="https://github.com/Aionic-Apps/aionic-core/blob/5342d02/src/api/components/milestone/announcement/model.ts#L15">api/components/milestone/announcement/model.ts:15</a></li>
127+
<li>Defined in <a href="https://github.com/Aionic-Apps/aionic-core/blob/0ac5593/src/api/components/milestone/announcement/model.ts#L15">api/components/milestone/announcement/model.ts:15</a></li>
128128
</ul>
129129
</aside>
130130
</section>
@@ -134,7 +134,7 @@ <h3>id</h3>
134134
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
135135
<aside class="tsd-sources">
136136
<ul>
137-
<li>Defined in <a href="https://github.com/Aionic-Apps/aionic-core/blob/5342d02/src/api/components/milestone/announcement/model.ts#L9">api/components/milestone/announcement/model.ts:9</a></li>
137+
<li>Defined in <a href="https://github.com/Aionic-Apps/aionic-core/blob/0ac5593/src/api/components/milestone/announcement/model.ts#L9">api/components/milestone/announcement/model.ts:9</a></li>
138138
</ul>
139139
</aside>
140140
<div class="tsd-comment tsd-typography">
@@ -149,7 +149,7 @@ <h3>important</h3>
149149
<div class="tsd-signature tsd-kind-icon">important<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
150150
<aside class="tsd-sources">
151151
<ul>
152-
<li>Defined in <a href="https://github.com/Aionic-Apps/aionic-core/blob/5342d02/src/api/components/milestone/announcement/model.ts#L20">api/components/milestone/announcement/model.ts:20</a></li>
152+
<li>Defined in <a href="https://github.com/Aionic-Apps/aionic-core/blob/0ac5593/src/api/components/milestone/announcement/model.ts#L20">api/components/milestone/announcement/model.ts:20</a></li>
153153
</ul>
154154
</aside>
155155
</section>

‎docs/classes/announcementcontroller.html

Lines changed: 53 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> service</h3>
104104
<div class="tsd-signature tsd-kind-icon">service<span class="tsd-signature-symbol">:</span> <a href="announcementservice.html" class="tsd-signature-type">AnnouncementService</a><span class="tsd-signature-symbol"> =&nbsp;new AnnouncementService()</span></div>
105105
<aside class="tsd-sources">
106106
<ul>
107-
<li>Defined in <a href="https://github.com/Aionic-Apps/aionic-core/blob/5342d02/src/api/components/milestone/announcement/controller.ts#L8">api/components/milestone/announcement/controller.ts:8</a></li>
107+
<li>Defined in <a href="https://github.com/Aionic-Apps/aionic-core/blob/0ac5593/src/api/components/milestone/announcement/controller.ts#L8">api/components/milestone/announcement/controller.ts:8</a></li>
108108
</ul>
109109
</aside>
110110
</section>
@@ -121,21 +121,33 @@ <h3>create<wbr>Announcement</h3>
121121
<li class="tsd-description">
122122
<aside class="tsd-sources">
123123
<ul>
124-
<li>Defined in <a href="https://github.com/Aionic-Apps/aionic-core/blob/5342d02/src/api/components/milestone/announcement/controller.ts#L61">api/components/milestone/announcement/controller.ts:61</a></li>
124+
<li>Defined in <a href="https://github.com/Aionic-Apps/aionic-core/blob/0ac5593/src/api/components/milestone/announcement/controller.ts#L67">api/components/milestone/announcement/controller.ts:67</a></li>
125125
</ul>
126126
</aside>
127127
<div class="tsd-comment tsd-typography">
128+
<div class="lead">
129+
<p>Create announcement</p>
130+
</div>
128131
</div>
129132
<h4 class="tsd-parameters-title">Parameters</h4>
130133
<ul class="tsd-parameters">
131134
<li>
132135
<h5>req: <span class="tsd-signature-type">Request</span></h5>
136+
<div class="tsd-comment tsd-typography">
137+
<p>Express request</p>
138+
</div>
133139
</li>
134140
<li>
135141
<h5>res: <span class="tsd-signature-type">Response</span></h5>
142+
<div class="tsd-comment tsd-typography">
143+
<p>Express response</p>
144+
</div>
136145
</li>
137146
<li>
138147
<h5>next: <span class="tsd-signature-type">NextFunction</span></h5>
148+
<div class="tsd-comment tsd-typography">
149+
<p>Express next</p>
150+
</div>
139151
</li>
140152
</ul>
141153
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
@@ -153,21 +165,33 @@ <h3>delete<wbr>Announcement</h3>
153165
<li class="tsd-description">
154166
<aside class="tsd-sources">
155167
<ul>
156-
<li>Defined in <a href="https://github.com/Aionic-Apps/aionic-core/blob/5342d02/src/api/components/milestone/announcement/controller.ts#L82">api/components/milestone/announcement/controller.ts:82</a></li>
168+
<li>Defined in <a href="https://github.com/Aionic-Apps/aionic-core/blob/0ac5593/src/api/components/milestone/announcement/controller.ts#L90">api/components/milestone/announcement/controller.ts:90</a></li>
157169
</ul>
158170
</aside>
159171
<div class="tsd-comment tsd-typography">
172+
<div class="lead">
173+
<p>Delete announcement</p>
174+
</div>
160175
</div>
161176
<h4 class="tsd-parameters-title">Parameters</h4>
162177
<ul class="tsd-parameters">
163178
<li>
164179
<h5>req: <span class="tsd-signature-type">Request</span></h5>
180+
<div class="tsd-comment tsd-typography">
181+
<p>Express request</p>
182+
</div>
165183
</li>
166184
<li>
167185
<h5>res: <span class="tsd-signature-type">Response</span></h5>
186+
<div class="tsd-comment tsd-typography">
187+
<p>Express response</p>
188+
</div>
168189
</li>
169190
<li>
170191
<h5>next: <span class="tsd-signature-type">NextFunction</span></h5>
192+
<div class="tsd-comment tsd-typography">
193+
<p>Express next</p>
194+
</div>
171195
</li>
172196
</ul>
173197
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
@@ -185,21 +209,33 @@ <h3>read<wbr>Announcement</h3>
185209
<li class="tsd-description">
186210
<aside class="tsd-sources">
187211
<ul>
188-
<li>Defined in <a href="https://github.com/Aionic-Apps/aionic-core/blob/5342d02/src/api/components/milestone/announcement/controller.ts#L34">api/components/milestone/announcement/controller.ts:34</a></li>
212+
<li>Defined in <a href="https://github.com/Aionic-Apps/aionic-core/blob/0ac5593/src/api/components/milestone/announcement/controller.ts#L38">api/components/milestone/announcement/controller.ts:38</a></li>
189213
</ul>
190214
</aside>
191215
<div class="tsd-comment tsd-typography">
216+
<div class="lead">
217+
<p>Read announcement</p>
218+
</div>
192219
</div>
193220
<h4 class="tsd-parameters-title">Parameters</h4>
194221
<ul class="tsd-parameters">
195222
<li>
196223
<h5>req: <span class="tsd-signature-type">Request</span></h5>
224+
<div class="tsd-comment tsd-typography">
225+
<p>Express request</p>
226+
</div>
197227
</li>
198228
<li>
199229
<h5>res: <span class="tsd-signature-type">Response</span></h5>
230+
<div class="tsd-comment tsd-typography">
231+
<p>Express response</p>
232+
</div>
200233
</li>
201234
<li>
202235
<h5>next: <span class="tsd-signature-type">NextFunction</span></h5>
236+
<div class="tsd-comment tsd-typography">
237+
<p>Express next</p>
238+
</div>
203239
</li>
204240
</ul>
205241
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
@@ -217,21 +253,33 @@ <h3>read<wbr>Announcements</h3>
217253
<li class="tsd-description">
218254
<aside class="tsd-sources">
219255
<ul>
220-
<li>Defined in <a href="https://github.com/Aionic-Apps/aionic-core/blob/5342d02/src/api/components/milestone/announcement/controller.ts#L17">api/components/milestone/announcement/controller.ts:17</a></li>
256+
<li>Defined in <a href="https://github.com/Aionic-Apps/aionic-core/blob/0ac5593/src/api/components/milestone/announcement/controller.ts#L19">api/components/milestone/announcement/controller.ts:19</a></li>
221257
</ul>
222258
</aside>
223259
<div class="tsd-comment tsd-typography">
260+
<div class="lead">
261+
<p>Read announcements</p>
262+
</div>
224263
</div>
225264
<h4 class="tsd-parameters-title">Parameters</h4>
226265
<ul class="tsd-parameters">
227266
<li>
228267
<h5>req: <span class="tsd-signature-type">Request</span></h5>
268+
<div class="tsd-comment tsd-typography">
269+
<p>Express request</p>
270+
</div>
229271
</li>
230272
<li>
231273
<h5>res: <span class="tsd-signature-type">Response</span></h5>
274+
<div class="tsd-comment tsd-typography">
275+
<p>Express response</p>
276+
</div>
232277
</li>
233278
<li>
234279
<h5>next: <span class="tsd-signature-type">NextFunction</span></h5>
280+
<div class="tsd-comment tsd-typography">
281+
<p>Express next</p>
282+
</div>
235283
</li>
236284
</ul>
237285
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>

‎docs/classes/announcementroutes.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ <h3>constructor</h3>
119119
<li class="tsd-description">
120120
<aside class="tsd-sources">
121121
<ul>
122-
<li>Defined in <a href="https://github.com/Aionic-Apps/aionic-core/blob/5342d02/src/api/components/milestone/announcement/routes.ts#L10">api/components/milestone/announcement/routes.ts:10</a></li>
122+
<li>Defined in <a href="https://github.com/Aionic-Apps/aionic-core/blob/0ac5593/src/api/components/milestone/announcement/routes.ts#L10">api/components/milestone/announcement/routes.ts:10</a></li>
123123
</ul>
124124
</aside>
125125
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -141,7 +141,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> _router</h3>
141141
<div class="tsd-signature tsd-kind-icon">_router<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Router</span><span class="tsd-signature-symbol"> =&nbsp;Router()</span></div>
142142
<aside class="tsd-sources">
143143
<ul>
144-
<li>Defined in <a href="https://github.com/Aionic-Apps/aionic-core/blob/5342d02/src/api/components/milestone/announcement/routes.ts#L10">api/components/milestone/announcement/routes.ts:10</a></li>
144+
<li>Defined in <a href="https://github.com/Aionic-Apps/aionic-core/blob/0ac5593/src/api/components/milestone/announcement/routes.ts#L10">api/components/milestone/announcement/routes.ts:10</a></li>
145145
</ul>
146146
</aside>
147147
</section>
@@ -151,7 +151,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> auth<wbr>Serivce</h3>
151151
<div class="tsd-signature tsd-kind-icon">auth<wbr>Serivce<span class="tsd-signature-symbol">:</span> <a href="authservice.html" class="tsd-signature-type">AuthService</a></div>
152152
<aside class="tsd-sources">
153153
<ul>
154-
<li>Defined in <a href="https://github.com/Aionic-Apps/aionic-core/blob/5342d02/src/api/components/milestone/announcement/routes.ts#L9">api/components/milestone/announcement/routes.ts:9</a></li>
154+
<li>Defined in <a href="https://github.com/Aionic-Apps/aionic-core/blob/0ac5593/src/api/components/milestone/announcement/routes.ts#L9">api/components/milestone/announcement/routes.ts:9</a></li>
155155
</ul>
156156
</aside>
157157
</section>
@@ -161,7 +161,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> controller</h3>
161161
<div class="tsd-signature tsd-kind-icon">controller<span class="tsd-signature-symbol">:</span> <a href="announcementcontroller.html" class="tsd-signature-type">AnnouncementController</a><span class="tsd-signature-symbol"> =&nbsp;new AnnouncementController()</span></div>
162162
<aside class="tsd-sources">
163163
<ul>
164-
<li>Defined in <a href="https://github.com/Aionic-Apps/aionic-core/blob/5342d02/src/api/components/milestone/announcement/routes.ts#L8">api/components/milestone/announcement/routes.ts:8</a></li>
164+
<li>Defined in <a href="https://github.com/Aionic-Apps/aionic-core/blob/0ac5593/src/api/components/milestone/announcement/routes.ts#L8">api/components/milestone/announcement/routes.ts:8</a></li>
165165
</ul>
166166
</aside>
167167
</section>
@@ -178,7 +178,7 @@ <h3>router</h3>
178178
<li class="tsd-description">
179179
<aside class="tsd-sources">
180180
<ul>
181-
<li>Defined in <a href="https://github.com/Aionic-Apps/aionic-core/blob/5342d02/src/api/components/milestone/announcement/routes.ts#L18">api/components/milestone/announcement/routes.ts:18</a></li>
181+
<li>Defined in <a href="https://github.com/Aionic-Apps/aionic-core/blob/0ac5593/src/api/components/milestone/announcement/routes.ts#L18">api/components/milestone/announcement/routes.ts:18</a></li>
182182
</ul>
183183
</aside>
184184
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Router</span></h4>
@@ -198,7 +198,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> init<wbr>Routes</h3>
198198
<li class="tsd-description">
199199
<aside class="tsd-sources">
200200
<ul>
201-
<li>Defined in <a href="https://github.com/Aionic-Apps/aionic-core/blob/5342d02/src/api/components/milestone/announcement/routes.ts#L22">api/components/milestone/announcement/routes.ts:22</a></li>
201+
<li>Defined in <a href="https://github.com/Aionic-Apps/aionic-core/blob/0ac5593/src/api/components/milestone/announcement/routes.ts#L22">api/components/milestone/announcement/routes.ts:22</a></li>
202202
</ul>
203203
</aside>
204204
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>

0 commit comments

Comments
 (0)