Better API documentation

  • 0 Replies
  • 835 Views
*

Offline RaduP

  • *****
  • 890
Better API documentation
« on: 09 / May / 2008, 02:48:14 »
Advertisements
I am a C programmer with over 6 years of C experience, and about 6 other years of X86 ASM experience.
I am pretty busy with my actual work, but I find the CHDK project very fascinating, and I would like to experiment with the C source when I have some time, and if I do anything interesting, I'll make sure to let you guys know.

I looked on the project's wiki page, but couldn't find the information I need, so in case I missed something, I think it would be a good idea to have a page that describes the following things:
1. Device specs (how much program and data memory is available, CPU speed, etc.)
2. What kind of native (firmware) API is available. For example, how do you get the data from the sensor, how do you change the focus, andso on).
3. Known I/O ports (if any) that can be accessed by the user program.

Now, I realize that a lot of this information can be obtained by reading the source code, but I think it would be easier for new programmers to get an idea if there was some sort of Developer FAQ thing.

And yes, I know, we, programmers, hate writting documentation :)

 

Related Topics