1
redheadedrod
Documentation...

When possible if you take the time to tear apart a module to make it a "Blue module" lets make sure we document as much as we can.

Doxygen is a utility we can use to document functions, classes etc and is one used to build the API documents so it is a good one to use for documenting the modules.

This utility will take comments we put in the code and pull it out to document what the code does. It would be a GREAT thing if while you are redoing the code and you figure out the different functions , classes etc to comment them in the code so that you can create a full function diagram. This will help you as you try to fix and convert modules but also will help developers in the future if you don't continue to develop the module for whatever reason.

Another thing that would be good is to document the usage of the module to help users of the modules. There are alot of modules out there that I have come accross that have no instructions how to use them. So if you have the ability to document the use of the module it would also be a great thing for everyone out there.

Again if you are taking the time to tear apart the module and fix it hopefully you will also document how to use the module as well.

Also make sure to document what versions you tested the module on to help people decide to try it or not. Also if there are any dependencies for the module it would be a good idea to list those as well. (For instance if a "smart" module needs the "smartobjects" module to operate it should be mentioned in the documentation.)

Login

Who's Online

176 user(s) are online (104 user(s) are browsing Support Forums)


Members: 0


Guests: 176


more...

Donat-O-Meter

Stats
Goal: $100.00
Due Date: Mar 31
Gross Amount: $0.00
Net Balance: $0.00
Left to go: $100.00
Make donations with PayPal!

Latest GitHub Commits