issie icon indicating copy to clipboard operation
issie copied to clipboard

Organise the code base

Open tomcl opened this issue 11 months ago • 1 comments

Describe the bug

The code should be better documented and factored into namespaces above module level

Expected behavior

  • We should have XML descriptions of every module for the API docs.
  • We should divide modules into namespaces roughly according to the current subdirectory structure, e.g:
    • EEExtensions
    • Common
    • UART
    • Interface
    • Model
    • Draw
    • Simulator
    • Verilog
    • UI
    • Truthtable
    • WaveSim
    • Main (includes all the update-related modules and UI/mainview)
  • Reorganise folders so namespace = folder

tomcl avatar Apr 05 '25 20:04 tomcl

Renaming types

We should rename the SymbolT, BusWireT, SheetT Model types as SymModel WireModel, DrawModel.

We should refactor Model types a bit more to organise fields and reduce top-level size.

We should refactor Symbol update like BusWire update to allow it to change the whole Model.

This must be done when no-one else is working on Issie!

tomcl avatar Apr 07 '25 09:04 tomcl