VOGONS


Comment patch

Topic actions

First post, by CarlKenner

User metadata
Rank Newbie
Rank
Newbie

OK, I'm working on a patch. It thoroughly changes just about every file. But I don't think it will be too controversial, because... it only adds comments!

Yes, I'm sick to death of not having any comments in the code. (Except a few randomly placed cryptic ones).

So I'm commenting it all! Now people will know what each file does. And they will know what the important functions do. And they will even know the basic specs for the hardware it is emulating.

Currently I've got so far as bios.h and bios.cpp.

Commenting is actually surprisingly fun, and it is useful to people and a useful learning experience for me.

Reply 2 of 3, by MiniMax

User metadata
Rank Moderator
Rank
Moderator

In the past I have used Doxygen to automate the generation of documentation for some C-code. If you don't know it, have a look.

DOSBox 60 seconds guide | How to ask questions
_________________
Lenovo M58p | Core 2 Quad Q8400 @ 2.66 GHz | Radeon R7 240 | LG HL-DT-ST DVDRAM GH40N | Fedora 32

Reply 3 of 3, by `Moe`

User metadata
Rank Oldbie
Rank
Oldbie

Right, if you're doing that huge task, make sure it is in a Doxygen-compatible format. That way, people can actually browse the developer docs.