Rockbox mail archive
Subject: Re: API Docs
From: BlueChip (cs_bluechip_at_webtribe.net)
There IS and API document in the source code /docs folder, but it is *VERY*
There is generally one representative of each "group" of functions in the
So armed with grep and the name of one function you can normally identify
the source file which holds the full set of functions in THAT group.
I can whole heartedly recommend AgentRansack(.com) to grep the source tree.
Does that all make sense?
Also beware that some of the API docs are (iirc) wrong - so you may want to
double check the details that are already there.
On the other hand, it should be quite easy to produce a new document (for
which many of us will thank you) as once you have located the relevant
source files (all *.c files :)) it's all pretty obvious what is going on :)
...just time consuming to make it look good.
>I finally got my dev environment setup and was even able to create a
>simple hello-world type program that ran. How exciting.
>I'm looking for some documentation on the plugin API, however. The link on
>the docs page (http://rockbox.haxx.se/docs/) has a place for the api docs,
>but doesn't link anywhere. I'm assuming they don't exist yet? If it does,
>can someone point me to it? If it doesn't, can someone tell me how to find
>the info I need and I would happily write the api docs as I learn it myself.
>It's been a long time since I've written in c, so I'll be having to
>relearn that as well.
Page was last modified "Jan 10 2012" The Rockbox Crew