Skip to content

Improvement: Documentation how method Application::Run() works #158

@BjoernAtBosch

Description

@BjoernAtBosch

The documentation in class score::mw::lifecycle::Application for method Run() is somewhat misleading/unprecise.

Regarding the return code it states:

\return 0 on successful initialization, non-zero otherwise.

This seems to be a copy&pasto from the Initialize method. But it also leads to a more important question from an app developer's point of perspective:

  1. May/shall the implementation of the Run method of an application "consume"/"take hold" of the calling thread until the application is stopped? The return code would represent the overall outcome of the
  2. Or shall the calling thread just be used to change the state to "running", i.e. if required spawning separate threads to do the actual work, and return asap; reporting with the return code if the app did change to running state successfully.

My guess is the first alternative, but it would be helpful to clearly state this in the documentation of this class.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Status

    Backlog

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions