Re: native API documentation

Alexander Bertram
 

Many thanks for this Lukas and Karl, very helpful. 

I've integrated the documentation into Renjin's compatibility layer- very helpful!

Best,
Alex


On Fri, Jan 13, 2017 at 3:38 PM Lukas Stadler <lukas.stadler@...> wrote:
Hi,

also, in the meantime, Karl took the time to push additional API documentation (mostly done by Andrew Runnalls) to my github “API documentation” repository.
The automatically generated html documentation is available at https://lukasstadler.github.io/RAPI/html/
The list of functions is a good starting point: https://lukasstadler.github.io/RAPI/html/globals_func.html

This repo now contains documentation for ~100 functions and adds parameter names for 172 functions (almost all provided by Karl).
Even though it doesn’t cover all of the API, this would already be very helpful for someone looking at native code that interfaces with R.

I know that there’s differing opinions as to whether doxygen is the right technology, and what exactly the documentation of functions should contain, but the documentation in this form exists and is already useful.
So I’d ultimately like to bring this topic up with r-devel as well, separated into the parameter names and doxygen comments.

Best,
 Lukas

_______________________________________________
Rconsortium-wg-api mailing list
Rconsortium-wg-api@...
https://lists.r-consortium.org/mailman/listinfo/rconsortium-wg-api

Join Rconsortium-wg-api@lists.r-consortium.org to automatically receive all group messages.