search

KhronosGroup / webcl-validator

WebCL Validator
Other
38 stars 8 forks source link

Write documentation for C API. #83

Open elhigu opened 10 years ago

elhigu commented 10 years ago

First version of API is fully functional (Issue #51). Now we should write API reference and also document for integrators how this is intended to be used and how library should be linked in. I.e how to actually use our library after it was compiled as a part of llvm/clang tree.

tonikitoo commented 10 years ago

Is there any progresses here? I would like to get pointed to a how-to embed the validator?

--Antonio (WebKit & Blink / WebCL).

elhigu commented 10 years ago

Currently easiest way to learn how to use library is to check https://github.com/KhronosGroup/webcl-validator/blob/master/driver/main.cpp how clv APIs are used.

API header is here https://github.com/KhronosGroup/webcl-validator/blob/master/include/clv/clv.h

Basically one needs to include header and link libclv_standalone in. Probably tutorial approach for different platforms + better API comments in clv.h would be enough.