Reef Angel Forum

I am not sure if this is the best place to post this but here goes anyway.

I am new to ReefAngel but not new to programming on microControllers such as the AVR and PIC series. I have looked but cannot find any kind of API documentation. Does this exist? I know about RAGen but would like some additional docs on the functions.

Thanks

Hi,
Because this is always an on going evolution, we never made any kind of API documentation.
The very basic documentation there is is very outdated and was really made for the old standard libraries.
Since then, the functions have evolved and we've got so much more now that it is considered obsolete.
This is a wiki of the old libraries:
https://github.com/reefangel/Reef-Angel ... iki/_pages
We would love if you would be interested in helping us and start one

All of my modifications to the libraries are located here:

https://github.com/curtbinder/ReefAngel

Also, some of my guides make mention to some API calls for the different libraries as well. It's kinda rough but at least it's something.

http://forum.reefangel.com/viewtopic.php?f=14&t=109
http://forum.reefangel.com/viewtopic.php?f=14&t=311

Like Roberto said, the API documentation is rather "rough" and has not been kept up.

curt

Okee Dokee, I'll look at the links you posted.

I do need to compliment you both on this product. It is great.

Roberto, I am anxiously awaiting the display mentioned in another thread. I had actually thought of doing that myself.

thanks for the help

rimai wrote:Hi,
Because this is always an on going evolution, we never made any kind of API documentation.
The very basic documentation there is is very outdated and was really made for the old standard libraries.
Since then, the functions have evolved and we've got so much more now that it is considered obsolete.
This is a wiki of the old libraries:
https://github.com/reefangel/Reef-Angel ... iki/_pages
We would love if you would be interested in helping us and start one

OK so call me slow . I just noticed the comment about helping out with the docs. To that I will reply, "Sure". Actually I will see what I can do. It will be awhile before I can start due to being slammed at both my "day" and "night" jobs, but that should all clear up in a couple of weeks. After that as I set up my controller I'll see what I can do about updating the docs.

Awesome!!!
Let us know when things free up a bit for you

If you are familiar with Doxygen, you could work on using that for the header files in the libraries. Then I can generate the documentation based on the comments you have created and publish it easily in a PDF or HTML format.

Just a thought. I've used Doxygen in the past but haven't taken the time to write up all the comments for everything. I started to do that for ragen, but haven't kept up with it.

curt

Never used Doxygen but no reason I can't figure it out. I'll look into that and give it a shot.

rimai wrote:Awesome!!!
Let us know when things free up a bit for you

I'll do that. A quick off topic question. How is the display board coming along?