Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation of c-api functions #62

Open
JCBurnside opened this issue Nov 12, 2023 · 3 comments
Open

Documentation of c-api functions #62

JCBurnside opened this issue Nov 12, 2023 · 3 comments

Comments

@JCBurnside
Copy link

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.

@smaludzi
Copy link
Member

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.

@JCBurnside
Copy link
Author

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

@smaludzi
Copy link
Member

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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants