Bernd Mathiske created MESOS-2478:
-------------------------------------
Summary: Document libprocess
Key: MESOS-2478
URL: https://issues.apache.org/jira/browse/MESOS-2478
Project: Mesos
Issue Type: Documentation
Components: libprocess
Reporter: Bernd Mathiske
We can gain development velocity by augmenting the documentation of the central
work horse library of Mesos: libprocess. Specifically, there is opportunity to:
- Give an overview of the library's purpose and contents.
- Explain the underlying design goals and principles.
- Explain file/class/feature purposes and how they relate to each other.
- Specify parts of the library's API, both its interfaces/signatures and the
expected usage protocols/patterns.
- Point out important invariants, constraints and limitations.
- Provide some example usage code.
Let's use Doxygen so that we can keep the documentation effort close to the
source code and facilitate keeping both in sync. Thus we can create both
immediately useful source code comments and we can also generate an API
reference manual, which can be used both online and offline.
This means that we will deviate from the current source code comment format and
switch over to Doxygen format for all publicly visible parts of libprocess, and
potentially also for the rest of it. So the first task is to come up with a
specific Doxygen style that we then want to apply consistently.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
