DIYEFI.org Forum

So, I thought I would publish a snapshot doxy output on the server:

http://docs.freeems.org/doxygen-html/index.html

IE, read as much as you can stand and comment on it ruthlessly

• Stuff that makes no sense
• Stuff that looks out of date
• etc.

Post any stuff you think needs doing here, or, if you think you can do better, fork on github and start making commits and let me know to bring them in.

Thanks! :-)

Fred.

Under the simple.c code, it notes this.

"Here is the call graph for this function:"

But no call graph is shown. When I run Doxygen on my machine, it inserts a failed graphic.

Fixed by installing graphviz on the server and regenerating, thanks! Reload.

Tried to install doxygen on this box and couldn't get it, dependency issues. Will get it working on this box soonish.

Fred.

I got another 10 minutes to look things over.

Under glossary, adding staged injectors, speed density, Ion sense, PIT ECT (Timer), PLL, OV (OverVoltage), TVS (Transient Voltage Suppression) come to mind. Also ordering those instead of all jumbled the way they are now.
http://docs.freeems.org/doxygen-html/glossary.html

It's my current understanding that after init, the code operates largely by IRQ, and passes data via tables. Perhaps under the modules something that details the tables, and their layout would be handy.

At here,
http://docs.freeems.org/doxygen-html/d1 ... isers.html
TunableConfig.c TunableConfig2.c, don't have the brief comments. Same thing here.
http://docs.freeems.org/doxygen-html/d5 ... aders.html

From this page http://docs.freeems.org/doxygen-html/files.html GM.h ??? NA-FE-DOHC.H ??? description for staticInit.c ?

It's basically small stuff so far. I'll try to get some time and jump into commenting on actual code in the near future.

some of that table stuff is in docs/FreeEMS-MemoryManagement.???

Thanks for that, I hadn't read it for a long time. It seems to still be pretty much up to date. I would still like to update the code comments to inlclude *some* of the material from that or similar, though.

Also, thanks Jared for that criticism in the first place, I'll look it over tonight.

Fred.

jharvey wrote:Under glossary, adding staged injectors, speed density, Ion sense, PIT ECT (Timer), PLL, OV (OverVoltage), TVS (Transient Voltage Suppression) come to mind. Also ordering those instead of all jumbled the way they are now.
http://docs.freeems.org/doxygen-html/glossary.html

Fixed the formatting of it, but didn't change the content, some time later.

TunableConfig.c TunableConfig2.c, don't have the brief comments. Same thing here.

Done.

From this page http://docs.freeems.org/doxygen-html/files.html GM.h ??? NA-FE-DOHC.H ??? description for staticInit.c ?

Empty files and done, respectively.

Fred.

Should there be an module titled something like init, startup or main? Basically a module about the code that is fired off on startup, and eventually goes to the main loop. Seems the IRQs and special code chunks have a module, but the startup and normal operation code doesn't.

I don't think the make file(s) will play as nicely with Doxygen as the C files do. Is it ridiculous to get the makefile(s) included in the doxygen files?

And that's my 10 minutes for today.

I'll look into your first point this evening.

And to your second: http://docs.freeems.org/doxygen-html/unlisted.html

Fred.