cmdr
Check-in [66bd654074]
Not logged in
Myself Home DocumentationDownloads Tickets | Timeline Branches Tags Wiki Login

Many hyperlinks are disabled.
Use anonymous login to enable hyperlinks.

Overview
Comment:VT time::minute - Fixed documentation (2external, name of argument implied different type than actuually expected).
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA1: 66bd6540746c0a48a039c9922c668e011405097e
User & Date: aku 2015-07-03 05:30:27.427
Context
2015-07-03
22:34
Big set of 12 new validation types. These are facades/wrappers around the "valtype" snit validation types found in Tcllib (luhn, luhn5, verhoeff, gs1::ean13, iban, imei, isbn, usnpi, amex, visa, discover, mastercard). Documentation minimal, refers back to the Tcllib packages. Testsuites replicated here, under the general framework for VT testing. The facade code is fully generated based on the valtype name. The generator package is not documented (yet). check-in: 7d8a178853 user: andreask tags: trunk
05:30
VT time::minute - Fixed documentation (2external, name of argument implied different type than actuually expected). check-in: 66bd654074 user: aku tags: trunk
05:26
color - Updated the documentation. check-in: c82025d2d2 user: aku tags: trunk
Changes
Unified Diff Ignore Whitespace Patch
Changes to doc/cmdr_vt_time_minute.man.
︙︙
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

[para] The details of the exported standard API can be found in
[term [vset TITLE_DEV_VT]]. The chosen default is "now" to the minute.

[para] A single non-standard method is provided:

[list_begin definitions][comment {-- begin api definitions --}]
[comment {- - -- --- ----- -------- ------------- ---------------------}]
[call [cmd ::cmdr::validate::time] [method 2external] [arg epoch]]

This method converts the offset in minutes from midnight of a time to
the form %H:%M and returns the conversion result as its own.

[comment {- - -- --- ----- -------- ------------- ---------------------}]
[list_end][comment {-- end api definitions --}]









|








24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

[para] The details of the exported standard API can be found in
[term [vset TITLE_DEV_VT]]. The chosen default is "now" to the minute.

[para] A single non-standard method is provided:

[list_begin definitions][comment {-- begin api definitions --}]
[comment {- - -- --- ----- -------- ------------- ---------------------}]
[call [cmd ::cmdr::validate::time] [method 2external] [arg offset]]

This method converts the offset in minutes from midnight of a time to
the form %H:%M and returns the conversion result as its own.

[comment {- - -- --- ----- -------- ------------- ---------------------}]
[list_end][comment {-- end api definitions --}]
︙︙
Changes to embedded/man/files/cmdr_vt_time_minute.n.
︙︙
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293

.sp
package require \fBclock::iso8601 \fR
.sp
package require \fBcmdr::validate::common \fR
.sp
package require \fBcmdr::validate::time \fR
.sp
\fB::cmdr::validate::time\fR \fB2external\fR \fIepoch\fR
.sp
.BE
.SH DESCRIPTION
.PP
Welcome to the Cmdr project, written by Andreas Kupries\&.
.PP
For availability please read \fICmdr - How To Get The Sources\fR\&.








|








279
280
281
282
283
284
285
286
287
288
289
290
291
292
293

.sp
package require \fBclock::iso8601 \fR
.sp
package require \fBcmdr::validate::common \fR
.sp
package require \fBcmdr::validate::time \fR
.sp
\fB::cmdr::validate::time\fR \fB2external\fR \fIoffset\fR
.sp
.BE
.SH DESCRIPTION
.PP
Welcome to the Cmdr project, written by Andreas Kupries\&.
.PP
For availability please read \fICmdr - How To Get The Sources\fR\&.
︙︙
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318

The type has no input completion\&.
.PP
The details of the exported standard API can be found in
\fICmdr - Writing custom validation types\fR\&. The chosen default is "now" to the minute\&.
.PP
A single non-standard method is provided:
.TP
\fB::cmdr::validate::time\fR \fB2external\fR \fIepoch\fR
This method converts the offset in minutes from midnight of a time to
the form %H:%M and returns the conversion result as its own\&.
.PP
.SH "BUGS, IDEAS, FEEDBACK"
Both the package(s) and this documentation will undoubtedly contain
bugs and other problems\&.
Please report such at








|








304
305
306
307
308
309
310
311
312
313
314
315
316
317
318

The type has no input completion\&.
.PP
The details of the exported standard API can be found in
\fICmdr - Writing custom validation types\fR\&. The chosen default is "now" to the minute\&.
.PP
A single non-standard method is provided:
.TP
\fB::cmdr::validate::time\fR \fB2external\fR \fIoffset\fR
This method converts the offset in minutes from midnight of a time to
the form %H:%M and returns the conversion result as its own\&.
.PP
.SH "BUGS, IDEAS, FEEDBACK"
Both the package(s) and this documentation will undoubtedly contain
bugs and other problems\&.
Please report such at
︙︙
Changes to embedded/www/doc/files/cmdr_vt_time_minute.html.
︙︙
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156

<ul class="requirements">
<li>package require <b class="pkgname">try</b></li>
<li>package require <b class="pkgname">clock::iso8601</b></li>
<li>package require <b class="pkgname">cmdr::validate::common</b></li>
<li>package require <b class="pkgname">cmdr::validate::time</b></li>
</ul>
<ul class="syntax">
<li><a href="#1"><b class="cmd">::cmdr::validate::time</b> <b class="method">2external</b> <i class="arg">epoch</i></a></li>
</ul>
</div>
</div>
<div id="section1" class="section"><h2><a name="section1">Description</a></h2>
<p>Welcome to the Cmdr project, written by Andreas Kupries.</p>
<p>For availability please read <i class="term"><a href="cmdr_howto_get_sources.html">Cmdr - How To Get The Sources</a></i>.</p>
<p>This package provides the validation type
<b class="cmd">::cmdr::validate::time::minute</b> which accepts timestamps with
minute precision in ISO 8601 syntax (limited to without seconds), or
as integer offset in minutes from midnight (modulo 24 hours).</p>
<p>The internal representation is the offset in minutes from
midnight for the validated input.</p>
<p>The type has no input completion.</p>
<p>The details of the exported standard API can be found in
<i class="term"><a href="cmdr_vtypes.html">Cmdr - Writing custom validation types</a></i>. The chosen default is &quot;now&quot; to the minute.</p>
<p>A single non-standard method is provided:</p>
<dl class="definitions">
<dt><a name="1"><b class="cmd">::cmdr::validate::time</b> <b class="method">2external</b> <i class="arg">epoch</i></a></dt>
<dd><p>This method converts the offset in minutes from midnight of a time to
the form %H:%M and returns the conversion result as its own.</p></dd>
</dl>
</div>
<div id="section2" class="section"><h2><a name="section2">Bugs, Ideas, Feedback</a></h2>
<p>Both the package(s) and this documentation will undoubtedly contain
bugs and other problems.








|

















|








124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156

<ul class="requirements">
<li>package require <b class="pkgname">try</b></li>
<li>package require <b class="pkgname">clock::iso8601</b></li>
<li>package require <b class="pkgname">cmdr::validate::common</b></li>
<li>package require <b class="pkgname">cmdr::validate::time</b></li>
</ul>
<ul class="syntax">
<li><a href="#1"><b class="cmd">::cmdr::validate::time</b> <b class="method">2external</b> <i class="arg">offset</i></a></li>
</ul>
</div>
</div>
<div id="section1" class="section"><h2><a name="section1">Description</a></h2>
<p>Welcome to the Cmdr project, written by Andreas Kupries.</p>
<p>For availability please read <i class="term"><a href="cmdr_howto_get_sources.html">Cmdr - How To Get The Sources</a></i>.</p>
<p>This package provides the validation type
<b class="cmd">::cmdr::validate::time::minute</b> which accepts timestamps with
minute precision in ISO 8601 syntax (limited to without seconds), or
as integer offset in minutes from midnight (modulo 24 hours).</p>
<p>The internal representation is the offset in minutes from
midnight for the validated input.</p>
<p>The type has no input completion.</p>
<p>The details of the exported standard API can be found in
<i class="term"><a href="cmdr_vtypes.html">Cmdr - Writing custom validation types</a></i>. The chosen default is &quot;now&quot; to the minute.</p>
<p>A single non-standard method is provided:</p>
<dl class="definitions">
<dt><a name="1"><b class="cmd">::cmdr::validate::time</b> <b class="method">2external</b> <i class="arg">offset</i></a></dt>
<dd><p>This method converts the offset in minutes from midnight of a time to
the form %H:%M and returns the conversion result as its own.</p></dd>
</dl>
</div>
<div id="section2" class="section"><h2><a name="section2">Bugs, Ideas, Feedback</a></h2>
<p>Both the package(s) and this documentation will undoubtedly contain
bugs and other problems.
︙︙