This Bugzilla instance is a read-only archive of historic NetBeans bug reports. To report a bug in NetBeans please follow the project's instructions for reporting issues.

Bug 210023 - Documentation for declarative hint syntax
Summary: Documentation for declarative hint syntax
Status: NEW
Alias: None
Product: java
Classification: Unclassified
Component: Hints (show other bugs)
Version: 7.1
Hardware: All All
: P3 normal with 3 votes (vote)
Assignee: AlyonaStashkova
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2012-03-23 19:50 UTC by Jesse Glick
Modified: 2016-04-24 16:06 UTC (History)
7 users (show)

See Also:
Issue Type: DEFECT
Exception Reporter:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Jesse Glick 2012-03-23 19:50:06 UTC
There seems to be no real documentation of java.hints.declarative beyond Geertjan's blog post [1] or just reading source code (esp. DefaultRuleUtilities). Such a key feature deserves clear documentation, particularly when the syntax (including declarative tests!) is so hard to guess at, and feedback on incorrect syntax is minimal.

There should be a help topic for this, perhaps under Refactoring Java Source (in java.helpset). Context help should be bound to this from the *.hint/*.test editor, and from the Inspect and Transform dialog, and from the Jackpot Rules Debug Window.

[1] https://blogs.oracle.com/geertjan/entry/custom_declarative_hints_in_netbeans
Comment 1 Jesse Glick 2012-03-30 13:28:41 UTC
https://bitbucket.org/jlahoda/jackpot30/wiki/RulesLanguage apparently has some information too.
Comment 2 Geertjan Wielenga 2012-03-30 13:32:25 UTC
Assigning to Ken (who can assign it to someone in docs org). They should work with Jan Lahoda on this.
Comment 3 Kenneth Ganfield 2012-03-30 13:49:32 UTC
Assigning to Alyona
Comment 4 Jesse Glick 2012-04-12 14:38:46 UTC
spi.java.hints Javadoc also has some related information (in @TriggerPattern.value), but nbbuild/build.properties does not list it so this Javadoc is not being published!
Comment 5 Quality Engineering 2012-04-13 09:52:26 UTC
Integrated into 'main-golden', will be available in build *201204130400* on http://bits.netbeans.org/dev/nightly/ (upload may still be in progress)
Changeset: http://hg.netbeans.org/main-golden/rev/0f93efc07cbf
User: Jan Lahoda <jlahoda@netbeans.org>
Log: #210023: including spi.java.hints' javadoc in the list of under-development javadocs
Comment 6 Jesse Glick 2014-08-27 13:47:01 UTC
For example, is there any equivalent to

https://gcc.gnu.org/onlinedocs/cpp/Stringification.html

so I can replace

@AnnotationTakingNumber(123)

with

@AnnotationTakingString("#123")

?
Comment 7 err 2015-05-29 01:54:27 UTC
http://wiki.netbeans.org/JavaDeclarativeHintsFormat

has the best I've seen so far