{"action":"opened","issue":{"url":"https://api.github.com/repos/graalvm/sulong/issues/225","repository_url":"https://api.github.com/repos/graalvm/sulong","labels_url":"https://api.github.com/repos/graalvm/sulong/issues/225/labels{/name}","comments_url":"https://api.github.com/repos/graalvm/sulong/issues/225/comments","events_url":"https://api.github.com/repos/graalvm/sulong/issues/225/events","html_url":"https://github.com/graalvm/sulong/issues/225","id":152495787,"number":225,"title":"Documentation for truffle.h","user":{"login":"mrigger","id":14328197,"avatar_url":"https://avatars.githubusercontent.com/u/14328197?v=3","gravatar_id":"","url":"https://api.github.com/users/mrigger","html_url":"https://github.com/mrigger","followers_url":"https://api.github.com/users/mrigger/followers","following_url":"https://api.github.com/users/mrigger/following{/other_user}","gists_url":"https://api.github.com/users/mrigger/gists{/gist_id}","starred_url":"https://api.github.com/users/mrigger/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mrigger/subscriptions","organizations_url":"https://api.github.com/users/mrigger/orgs","repos_url":"https://api.github.com/users/mrigger/repos","events_url":"https://api.github.com/users/mrigger/events{/privacy}","received_events_url":"https://api.github.com/users/mrigger/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":0,"created_at":"2016-05-02T07:33:45Z","updated_at":"2016-05-02T07:33:45Z","closed_at":null,"body":"[truffle.h](https://github.com/graalvm/sulong/blob/master/include/truffle.h) is the most important API that Sulong provides. I think that the function names are mostly self-descriptive, even for people that did not use the interop API before. \r\n\r\nHowever, I think it would be important to explain the bigger context of the file, i.e., how interop roughly works, how one can use the file with an example, what Sulong will do with the function calls, and a rough overview of the functions provided.\r\n\r\nDocumenting the file will allow people who use Truffle for the first time to quickly understand interop."}}