never icon indicating copy to clipboard operation
never copied to clipboard

Documentation of c-api functions

Open JCBurnside opened this issue 2 years ago • 3 comments

I would love to know what each of the functions returns and perhaps a little bit of what each function does. Like while looking through object.h:134 I see that it returns char is that because you don't want to use bool for some reason? I am working on a library for rust to allow this to be embedded into a rust program and would love some more documentation.

JCBurnside avatar Nov 12 '23 22:11 JCBurnside

Hi, Thanks for the message. I will try to write documentation starting from public API. It will take some time though. Wrt to the bool it is C++ extension afaik.

S.

smaludzi avatar Nov 13 '23 12:11 smaludzi

actually _Bool has been a thing since C99 (I had to look this up)

JCBurnside avatar Nov 13 '23 14:11 JCBurnside

Hi @JCBurnside . I pushed branch https://github.com/never-lang/never/tree/public_api_doc which contains some initial documentation of the public API. You may check include/object.h file first. I will try to proceed with following files in the next days. However I wanted to let you know that something is happening regarding your issue. Take care!

smaludzi avatar Nov 29 '23 19:11 smaludzi