35
Refactor Plan
Jeff Young edited this page 2022-11-06 21:33:55 +00:00

Purpose

Over time, the KiCad code base has accumulated some cruft and design styles/names that no longer suit the modern code base. Refactoring these changes should be done eventually, but for various reasons (such as elements being exposed over the current SWIG Python API or too much code churn) they can't be done right away. Instead, a refactor will be done at the end of the development cycle.

Refactor Tasks

  • Rename function GetBuildVersion to GetFullVersion1
  • Remove redundant naming and general improvements in Doxygen comments.2
  • Change all the include header guards to match the header file's name.2
  • Consolidate all IO plugins and importers/exporters into a nicely structured directory hierarchy. See issue #4412.2
  • Rename all board objects to PCB_* for consistency with schematic object naming.2
    • PCB_FP_TEXT seems a bit much so I went with FP_* for footprint children.
    • most of these have been done
    • remaining are PAD, ZONE and FOOTPRINT
  • Organize common/tools to separate the actual tools from the framework pieces.2

Reasons for delaying


  1. This change would cause the current Python API to change ↩︎

  2. This change would introduce code churn during the development cycle ↩︎