Skip to content

Commit be6a70b

Browse files
andrewfgandrewfg
committed
various
- adopt copilot suggestions - update javadoc to match Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>
1 parent be55cb6 commit be6a70b

2 files changed

Lines changed: 48 additions & 43 deletions

File tree

‎bundles/org.openhab.core.config.core/schema/config-description-1.0.0.xsd‎

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -164,29 +164,35 @@
164164

165165
<xs:simpleType name="contextType">
166166
<xs:restriction base="xs:string">
167-
<xs:enumeration value="network-address"/>
168-
<xs:enumeration value="network-interface"/>
169-
<xs:enumeration value="serial-port"/>
170-
<xs:enumeration value="password"/>
171-
<xs:enumeration value="password-create"/>
167+
<xs:enumeration value="channel"/>
168+
<xs:enumeration value="channeltype"/>
172169
<xs:enumeration value="color"/>
170+
<xs:enumeration value="cronexpression"/>
173171
<xs:enumeration value="date"/>
174172
<xs:enumeration value="datetime"/>
173+
<xs:enumeration value="dayOfWeek"/>
175174
<xs:enumeration value="email"/>
175+
<xs:enumeration value="group"/>
176+
<xs:enumeration value="item"/>
177+
<xs:enumeration value="location"/>
176178
<xs:enumeration value="month"/>
177-
<xs:enumeration value="week"/>
178-
<xs:enumeration value="dayOfWeek"/>
179-
<xs:enumeration value="time"/>
179+
<xs:enumeration value="network-address"/>
180+
<xs:enumeration value="network-interface"/>
181+
<xs:enumeration value="page"/>
182+
<xs:enumeration value="password"/>
183+
<xs:enumeration value="password-create"/>
184+
<xs:enumeration value="persistenceService"/>
185+
<xs:enumeration value="rule"/>
186+
<xs:enumeration value="script"/>
187+
<xs:enumeration value="serial-port"/>
188+
<xs:enumeration value="service"/>
189+
<xs:enumeration value="tag"/>
180190
<xs:enumeration value="telephone"/>
181-
<xs:enumeration value="url"/>
182-
<xs:enumeration value="item"/>
183191
<xs:enumeration value="thing"/>
184-
<xs:enumeration value="group"/>
185-
<xs:enumeration value="tag"/>
186-
<xs:enumeration value="service"/>
187-
<xs:enumeration value="channel"/>
188-
<xs:enumeration value="rule"/>
189-
<xs:enumeration value="location"/>
192+
<xs:enumeration value="time"/>
193+
<xs:enumeration value="url"/>
194+
<xs:enumeration value="week"/>
195+
<xs:enumeration value="widget"/>
190196
</xs:restriction>
191197
</xs:simpleType>
192198

‎bundles/org.openhab.core.config.core/src/main/java/org/openhab/core/config/core/ConfigDescriptionParameter.java‎

Lines changed: 26 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -317,41 +317,40 @@ public boolean isMultiple() {
317317
* </p>
318318
*
319319
* <ul>
320-
* <li><b>network-address</b>: The configuration value represents an IPv4 or IPv6 address or domain name.</li>
321-
* <li><b>network-interface</b>: The configuration value represents a network interface name, e.g. eth0, wlan0.</li>
322-
* <li><b>serial-port</b>: The configuration value represents a serial port name, e.g. COM1, /dev/ttyS0.</li>
323-
* <li><b>password</b>: A alphanumeric password value (a user-interface might obscure the visible value)</li>
324-
* <li><b>password-create</b>: A alphanumeric passwort generator widget might be shown</li>
320+
* <li><b>channel</b>: A valid channel UID. A UI would probably show a channel selection widget.</li>
321+
* <li><b>channeltype</b>: A valid channel type UID. A UI would probably show a channel type selection widget.</li>
325322
* <li><b>color</b>: This value represents an RGB color value like #000000 - #ffffff or 12,12,12.</li>
323+
* <li><b>cronexpression</b>: A cron expression like "* * * * *". A user interface would probably show a cron
324+
* expression generator.</li>
326325
* <li><b>date</b>: A date string in the format "YYYY-MM-DD"</li>
327326
* <li><b>datetime</b>: A date and time string in the format "YYYY-MM-DD'T'hh:mm:ss", e.g.
328327
* "2019-12-31T23:59:59"</li>
329-
* <li><b>cronexpression</b>: A cron expression like "* * * * *". A user interface would probably show a cron
330-
* expression generator.</li>
328+
* <li><b>dayOfWeek</b>: A day of week [MON, TUE, WED, THU, FRI, SAT, SUN]</li>
331329
* <li><b>email</b>: The configuration value represents an email address, e.g. username@domain.com</li>
330+
* <li><b>group</b>: A valid group item "name". A UI would probably show an item selection widget.</li>
331+
* <li><b>item</b>: A valid item "name". A UI would probably show an item selection widget.</li>
332+
* <li><b>location</b>: A latitude,longitude[,altitude] GPS location. A UI would probably render a world map for
333+
* selection.</li>
332334
* <li><b>month</b>: A month of year [1-12]</li>
333-
* <li><b>week</b>: A week of year [0-52]</li>
334-
* <li><b>dayOfWeek</b>: A day of week [MON, TUE, WED, THU, FRI, SAT, SUN]</li>
335-
* <li><b>time</b>: A time string in the format "hh:mm:ss" or as milliseconds since epoch</li>
335+
* <li><b>network-address</b>: The configuration value represents an IPv4 or IPv6 address or domain name.</li>
336+
* <li><b>network-interface</b>: The configuration value represents a network interface name, e.g. eth0, wlan0.</li>
337+
* <li><b>page</b>: A valid page UID. A UI would probably show a page selection widget.</li>
338+
* <li><b>password</b>: A alphanumeric password value (a UI might obscure the visible value)</li>
339+
* <li><b>password-create</b>: A alphanumeric passwort generator widget might be shown</li>
340+
* <li><b>persistenceService</b>: A valid persistence service ID. A UI would probably show a persistence service
341+
* selection widget.</li>
342+
* <li><b>rule</b>: A valid rule uid. A UI would probably show a rule selection widget.</li>
343+
* <li><b>script</b>: The configuration value represents a script (javascript, python etc). A UI would probably
344+
* render a multi line editor.</li>
345+
* <li><b>serial-port</b>: The configuration value represents a serial port name, e.g. COM1, /dev/ttyS0.</li>
346+
* <li><b>service</b>: A valid service ID. A UI would probably show a service selection widget.</li>
347+
* <li><b>tag</b>: One tag or multiple tags separated by comma.</li>
336348
* <li><b>telephone</b>: A tel no</li>
349+
* <li><b>thing</b>: A valid thing UID. A UI would probably show a thing selection widget.</li>
350+
* <li><b>time</b>: A time string in the format "hh:mm:ss" or as milliseconds since epoch</li>
337351
* <li><b>url</b>: A web address</li>
338-
* <li><b>tag</b>: One tag or multiple tags separated by comma.</li>
339-
* <li><b>item</b>: A valid item "name". A user-interface would probably show an item selection widget.</li>
340-
* <li><b>thing</b>: A valid thing UID. A user-interface would probably show a thing selection widget.</li>
341-
* <li><b>group</b>: A valid group item "name". A user-interface would probably show an item selection widget.</li>
342-
* <li><b>service</b>: A valid service ID. A user-interface would probably show a service selection widget.</li>
343-
* <li><b>persistenceService</b>: A valid persistence service ID. A user-interface would probably show a persistence
344-
* service selection widget.</li>
345-
* <li><b>channel</b>: A valid channel UID. A user-interface would probably show a channel selection widget.</li>
346-
* <li><b>channeltype</b>: A valid channel type UID. A user-interface would probably show a channel type selection
347-
* widget.</li>
348-
* <li><b>rule</b>: A valid rule uid. A user-interface would probably show a rule selection widget.</li>
349-
* <li><b>script</b>: The configuration value represents a script (javascript, python etc). A user-interface would
350-
* probably render a multi line editor.</li>
351-
* <li><b>page</b>: A valid page UID. A user-interface would probably show a page selection widget.</li>
352-
* <li><b>widget</b>: A valid widget UID. A user-interface would probably show a widget selection widget.</li>
353-
* <li><b>location</b>: A latitude,longitude[,altitude] GPS location. A user-interface would probably render a world
354-
* map for selection.</li>
352+
* <li><b>week</b>: A week of year [0-52]</li>
353+
* <li><b>widget</b>: A valid widget UID. A UI would probably show a widget selection widget.</li>
355354
* </ul>
356355
*
357356
* @return the context of the configuration parameter (could be empty)

0 commit comments

Comments
 (0)