Skip to content

Organise the code base #531

@tomcl

Description

@tomcl

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions