View unanswered posts | View active topics It is currently Thu Nov 15, 2018 7:19 am



Reply to topic  [ 9 posts ] 
Doxygen documentation review, please assist! 
Author Message
Moderator
User avatar

Joined: Tue Jan 15, 2008 2:31 pm
Posts: 15194
Location: Home sweet home!
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.

_________________
DIYEFI.org - where Open Source means Open Source, and Free means Freedom
FreeEMS.org - the open source engine management system
FreeEMS dev diary and its comments thread and my turbo truck!
n00bs, do NOT PM or email tech questions! Use the forum!
The ever growing list of FreeEMS success stories!


Mon May 03, 2010 7:52 am
Profile WWW
1N4001 - Signed up
User avatar

Joined: Tue Jun 10, 2008 5:17 pm
Posts: 1607
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.


Mon May 03, 2010 10:44 am
Profile
Moderator
User avatar

Joined: Tue Jan 15, 2008 2:31 pm
Posts: 15194
Location: Home sweet home!
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.

_________________
DIYEFI.org - where Open Source means Open Source, and Free means Freedom
FreeEMS.org - the open source engine management system
FreeEMS dev diary and its comments thread and my turbo truck!
n00bs, do NOT PM or email tech questions! Use the forum!
The ever growing list of FreeEMS success stories!


Mon May 03, 2010 3:31 pm
Profile WWW
1N4001 - Signed up
User avatar

Joined: Tue Jun 10, 2008 5:17 pm
Posts: 1607
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.


Tue May 04, 2010 11:17 am
Profile
LQFP112 - Up with the play
User avatar

Joined: Thu Sep 10, 2009 9:23 am
Posts: 244
Location: Dayton, OH
some of that table stuff is in docs/FreeEMS-MemoryManagement.???


Tue May 04, 2010 4:18 pm
Profile
Moderator
User avatar

Joined: Tue Jan 15, 2008 2:31 pm
Posts: 15194
Location: Home sweet home!
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.

_________________
DIYEFI.org - where Open Source means Open Source, and Free means Freedom
FreeEMS.org - the open source engine management system
FreeEMS dev diary and its comments thread and my turbo truck!
n00bs, do NOT PM or email tech questions! Use the forum!
The ever growing list of FreeEMS success stories!


Tue May 04, 2010 6:46 pm
Profile WWW
Moderator
User avatar

Joined: Tue Jan 15, 2008 2:31 pm
Posts: 15194
Location: Home sweet home!
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.

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

Done.

Quote:
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.

_________________
DIYEFI.org - where Open Source means Open Source, and Free means Freedom
FreeEMS.org - the open source engine management system
FreeEMS dev diary and its comments thread and my turbo truck!
n00bs, do NOT PM or email tech questions! Use the forum!
The ever growing list of FreeEMS success stories!


Wed May 05, 2010 8:27 am
Profile WWW
1N4001 - Signed up
User avatar

Joined: Tue Jun 10, 2008 5:17 pm
Posts: 1607
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.


Wed May 05, 2010 11:27 am
Profile
Moderator
User avatar

Joined: Tue Jan 15, 2008 2:31 pm
Posts: 15194
Location: Home sweet home!
I'll look into your first point this evening.

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

Fred.

_________________
DIYEFI.org - where Open Source means Open Source, and Free means Freedom
FreeEMS.org - the open source engine management system
FreeEMS dev diary and its comments thread and my turbo truck!
n00bs, do NOT PM or email tech questions! Use the forum!
The ever growing list of FreeEMS success stories!


Wed May 05, 2010 3:44 pm
Profile WWW
Display posts from previous:  Sort by  
Reply to topic   [ 9 posts ] 

Who is online

Users browsing this forum: No registered users and 4 guests


You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot post attachments in this forum

Search for:
Jump to:  
Powered by phpBB® Forum Software © phpBB Group
Designed by ST Software for PTF. ColorizeIt.