Skip to content

Enhancement: Clean up the code-base for DML and KINP #2

Description

@Joshsora

A list of things I want to come back to after finishing the ObjectProperty system.

  • Switch from tabs to 4 spaces.
  • Combine ki::dml::runtime_error and ki::protocol::runtime_error.
  • Create more descriptive exception types and determine when each of them is appropriate.
  • Use ki::BitStream instead of std::stream in ki::dml and ki::protocol.
  • Modularize ki::protocol::net::Session.
  • Remove the triangle inheritance in ki::protocol::net.
  • Use instance-owned receive/send buffers instead of allocating buffers for every message.
  • Choose a C++ documentation generator and document everything.
  • Write in-depth tests. Strive for 80%+ coverage.
  • Make ki::protocol::net and ki::protocol::control non-dependant on ki::dml.
  • Pass strings by constant reference.
  • Make parameters constant if possible.
  • Consider thread-safety.
  • Look into using C++ smart pointers.
  • Use C++ style casting.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Projects

No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions