Fred's firmware development diary comments thread

[Fred]

Getting close now, but the private git urls are still wrong. they should

Code: Select all

git@github.com:username/etc

not

Code: Select all

git://github.com/etc

:-)

Fred.

[jharvey]

I had tried that, and failed. I then tried the other command, and it appeared to work, so I went with it. After looking closer at the problem I had, I noticed I copied the fingerprint into the public key location. So I fixed that, and all is good now. I've updated the wiki to use the other command.

[Fred]

Excellent :-)

[jharvey]

I was wondering, when you do the doxygen commenting, can you put a general description for each segment of code? For example ignitionISRs.c might have a comment section like this.

This code controls when ignition happens by reading data from tableX.varY and setting the PIT timer, when the PIT timer expires, ignition happens.

Basically declaring what goes in and what goes out of that section of code.

[Fred]

Yeah, I'm adding all sorts of comments that weren't there before :-)

In future I also plan to be releasing the docs with the code up front. That way I can just link the release notes and change log up on the web when I post about it :-)

BTW, I think you should do a preliminary doxy of aarons python :-) It would be cool if we had full on docs for both parts of the system.

Your call, could be interesting to look at it though.

Fred.

[jharvey]

I guess we can give that a try. I know Doxygen has options to optimise for C or Java. I haven't really thought much about trying it on other code. I'll add it to my todo list.

Also if the doxyfile is now with the source, it only take a minute or two to run. If you want to just run it then upload it, feel free. On your next release if I don't see it, then I'll do it. What ever way works best.

So your now a year ahead of me, eh.

[jharvey]

To do the doxygen thing, I'm not sure if I'll need the latest, and I'm certainly not going to compile it just for the heck of it. Here's the version I have installed, I'm fairly sure it will be just fine.

$ yum list installed | grep -i doxy
doxygen.i386 1:1.5.2-1.fc7 installed
doxygen-doxywizard.i386 1:1.5.2-1.fc7 installed

[Fred]

You don't have to compile it, the binary distribution works on most linus' just fine. There are stacks of bugs in doxygen and as much as it is quite nice even in the older stuff, the newer stuff is a bit better (though I prefer the old diagrams for header inheritance.

I think I'll do it this time anyway as I want to link the change log and release notes from it.

Fred.

[jharvey]

Note really a bug, but thought I'd post about it. From this page, http://freeems.aaronb.info/docs/doxygen ... aders.html clost should be close

[Fred]

Thanks! Fixed and pushed up. :-)

Fred.