search

TelluIoT / ThingML

The ThingML modelling language
https://github.com/TelluIoT/ThingML
Apache License 2.0
101 stars 32 forks source link

Annotations doc #187

Closed imberium closed 4 years ago

imberium commented 7 years ago

Hello

Is there any documentation for the annotations that you are using ?

(I could find this https://github.com/TelluIoT/ThingML/blob/master/Documentrospection/Annotation.html but it is incomplete)

Thanks

jakhog commented 7 years ago

Unfortunately, they are not very well documented, as they are evaluated at run-time when you compile your ThingML model to a target.

As you have already seen, there is the Documentrospection code that reads all the Java-source and tries to find places where we use specific annotations. But as you have noticed, it was last updated in October 2016, so there might be some changes.

If you are compiling ThingML from source, you can run the Documentrospection yourself to generate it again from the current Java source code.

Is there any specific ones that you are missing?

imberium commented 7 years ago

Actually several ones, I thought that it could be better to have this doc especially when it comes to the platform specific ones as usually people will not be experts of the platform. It may avoid to dive into the code trying to figure it out