Any plans about CHDK api's documents? - General Discussion and Assistance - CHDK Forum
supplierdeeply

Any plans about CHDK api's documents?

  • 1 Replies
  • 664 Views
*

Offline December172

  • *
  • 34
  • A student interested in the Canon P&S hack
Any plans about CHDK api's documents?
« on: 07 / November / 2022, 06:54:25 »
Advertisements
These days I've seen some Magic Lantern's codes.I found that they have many comments in their code.(convert to a full document by using doxygen)Could we make a simple documents like that?That can let the new developers to understand the API of CHDK easier,and it's not require lot of work like javadoc - just write some briefs before a function or a struct.I am making a simple documented version on my own build of CHDK.
IMO,not all functions should be appeared in documents,just should have the functions and structs which can use in module and main (non-platform-specified) CHDK code.Some other platform asm code shouldn't appear in the document(maybe we can make a step-by-step comment that on asm code - need more disassembly and digging into Canon code deeply ;)).
This just a request,we can wait CHDK be more stable and make it.
P.S:I know most of developers don't like to comment,but there have to be someone to do it.Start from now is also a good idea :xmas
Canon PowerShot ELPH 180 (IXUS 175).
(Seems most of you are older than me.... Anyone teen? )

*

Offline reyalp

  • ******
  • 14072
Re: Any plans about CHDK api's documents?
« Reply #1 on: 08 / November / 2022, 00:33:53 »
These days I've seen some Magic Lantern's codes.I found that they have many comments in their code.(convert to a full document by using doxygen)Could we make a simple documents like that?
Do you mean generated documentation like doxygen, or just more comments in the code? Is the Magic Langern doxygen output viewable somewhere?
Quote
P.S:I know most of developers don't like to comment,but there have to be someone to do it.Start from now is also a good idea :xmas
Well, I like comments and try write them where I think they'll be helpful. But the thing is, with CHDK, understanding things that would benefit from documentation often takes a lot of work, and documentation without understanding often does more harm than good. Things that are immediately obvious at a glance don't need much documentation ;)

So while I certainly welcome documentation, I'm not going to sit down and attempt document CHDK. If anyone wants to submit patches that improve documentation, I'll certainly consider them.

If there are areas you think particularly need additional documentation, feel free to post what they are.

As far as using something like doxygen goes, I'm not very interested in spending the time to set it up, but if someone else comes up with a good plan and wants to shepherd the project, that would be fine with me.
Don't forget what the H stands for.

 

Related Topics