Codesnippet Javadoc Doclet in Truffle

Jaroslav Tulach jaroslav.tulach at
Wed Dec 30 15:52:41 UTC 2015

Hello Truffle fans,
I've just finished integration of Codesnippet Doclet[1] into Truffle API. 
Check out BranchProfile( 
Javadoc and guess what is different!

Have you noticed the change compared to yesterday's version? No? I am not 
surprised, but there are changes.

The first visible change was done by changeset[2] which moves the sample code 
from inside of a comment to a test. As a result, we found out that the code 
was not compilable and we could fix it. Having sample code as part of tests 
really helps.

The other change is the use of <b></b> for all keywords and {@link} for 
imported classes. As a result the new sample code should be more closer to the 
code you see in your favorite IDE as well as more useful by giving you a 
chance to immediately jump to Javadoc of related classes. I still need to talk 
to our Javac expert to find out whether there is a chance to provide links to 
used methods as well...

I hope you like this new style. In case you maintain a part of Truffle API, 
consider migrating your sample code from Javadoc to {@codesnippet} 
infrastructure. Happy New Year!


More information about the graal-dev mailing list