For non-PhASAR-experts, the implementations of our flow-function- and edge-function factories is hard to understand. We should improve their documentation (also visually by drawing the affected ESG edges with ASCII-art).
Prerequisites
issue x
Out Of Scope
A isn't part of this
Acceptance Criteria
The following acceptance criteria are defined regarding the result of this story:
Clarify what the final result should be, not how to accomplish it.
[x] All flow-function templates inside FlowFunctions.h are properly documented
[x] All flow-function templates inside LLVMFlowFunctions.h are properly documented
Story
For non-PhASAR-experts, the implementations of our flow-function- and edge-function factories is hard to understand. We should improve their documentation (also visually by drawing the affected ESG edges with ASCII-art).
Prerequisites
Out Of Scope
Acceptance Criteria
The following acceptance criteria are defined regarding the result of this story: Clarify what the final result should be, not how to accomplish it.
Related Stories
Follow-up Stories