Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add JavaDoc to CID_ constants #19

Open
dmfs opened this issue Feb 10, 2022 · 0 comments
Open

Add JavaDoc to CID_ constants #19

dmfs opened this issue Feb 10, 2022 · 0 comments

Comments

@dmfs
Copy link
Contributor

dmfs commented Feb 10, 2022

In order to get some support from the IDE when working with CID_* constants, as a user of this plugin I'd like to have the content of some of the <channel> child elements and attributes in the JavaDoc of the constant.

For instance, given a channel like this:

<channel id="powerIn" typeId="power">
  <label>Consumed Power</label>
  <description>This is the power that the …</description>
</channel>

and a channel type like this:

<channel-type id="power">
    <item-type>Number:Power</item-type>
    <label>Active Power</label>
    <state readOnly="true" pattern="%d %unit%"/>
</channel-type>

The constant could look like this:

/**
 * <h1>Consumed Power (Active Power)</h1>
 * This is the power that the …
 * <p>
 * Type: Number:Power
*/
public static final String CID_POWERIN = "powerIn";
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

1 participant