Bug 511192 - Documentation of the C++ runtime API
Summary: Documentation of the C++ runtime API
Status: ASSIGNED
Alias: None
Product: Papyrus-rt
Classification: Modeling
Component: documentation (show other bugs)
Version: 0.8.0   Edit
Hardware: All All
: P3 normal
Target Milestone: 1.1.0   Edit
Assignee: Charles Rivet CLA
QA Contact:
URL:
Whiteboard:
Keywords: Documentation
Depends on:
Blocks:
 
Reported: 2017-01-27 08:41 EST by Ernesto Posse CLA
Modified: 2017-07-28 15:06 EDT (History)
2 users (show)

See Also:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Ernesto Posse CLA 2017-01-27 08:41:38 EST 
We need to document the runtime API, specifically the parts relevant to the user. This should cover at least the following:

umlrtcapsule.hh
umlrtcapsuleid.hh

umlrtprotocol.hh

umlrtframeprotocol.hh

umlrttimer.hh
umlrttimerid.hh
umlrttimerspec.hh

umlrtlogprotocol.hh

umlrtsignal.hh
umlrtinsignal.hh
umlrtoutsignal.hh


We should also have documentation for the command-line options of the generated executable.
Comment 1 Peter Cigehn CLA 2017-06-30 07:44:42 EDT 
Setting the Documentation keyword similar to Bug 489936.
Comment 2 Charles Rivet CLA 2017-07-28 15:06:53 EDT 
Moving to 1.1