kicad/todo.txt

35 lines
1.4 KiB
Plaintext

Here are some source code maintenance tasks that need to be done, and maybe some
folks will see these items and volunteer to do them.
*** make the ADD_MENUITEM macros in include/macros.h be static inline functions instead
of macros. e.g. w/o argument types:
static inline void ADD_MENUITEM(menu, id, text, icon)
{
wxMenuItem * l_item;
l_item = new wxMenuItem(menu, id, text);
l_item->SetBitmap(icon); menu->Append(l_item);
}
*** Add hierarchical menu to right mouse click in PCBNEW for the case when
multiple items are under the mouse cursor.
*** Set up a DOXYGEN environment starting with a configuration file that:
- understands the JavaDoc style comments that we have started using
- gives preference to comments in header files over *.cpp files
- outputs its HTML stuff relative to the base of trunk, say for example trunk/doxygen
- is then added to the svn repository (this configuration file only)
Then add a shell script and batch file to generate the docs using the config file.
Then review the generated docs and start to go through the source and make the
generated doxygen docs readable and clear using the JavaDoc style comments,
mostly in the header files. The error and warning output of the doxygen
compiler can help with this too.
*** Translate comments that are in French to English so there can be a broader
understanding by new developers.