Welcome to Scroom’s documentation!

At this point, this is a (very) incomplete amalgam of requirements, design, and implementation patterns.

Contents:

• Core requirements
  • Be fast
  • 80/20 rule
• Derived requirements
  • No popups
• A tour of the Scroom UI
• Principles
  • Solid principles
  • YAGNI
• Architecture
  • Overview
  • No startup or shutdown code
  • Asynchronous
• Patterns
  • RAII
  • The Threadpool
  • create() methods
• Problems and solutions
  • Static initialization order
  • Static destruction
  • All classes should be self-sufficient
• Coding guidelines
  • Naming conventions
  • Class layout
  • File names
  • Formatting
  • Clang-tidy

Indices and tables

• Index

• Module Index

• Search Page