Comments: megaphone

Previously...

• I puzzled through some ejabberd issues with send.
• I started testing the send functionality.
• I finished testing the send functionality (go me!).

Rather than wiring megaphone together with ejabberd, I decided to add some comments to the various functions that make up the megaphone module.

When trying to understand any source code, comments are incredibly important.  Unfortunately, these are often missing in open source projects so I find myself taking an inordinate amount of time just trying to understand what is going on, rather than contributing or whatever to the project.  I resolved therefore that my project would be different, hence my taking some time to comment what I have done.

Note that this is not due to something like cowardice with regards to seeing my system crash and burn when I try it out.  No sir.

Next time: comments for the sender and receiver modules.