Skip to content
Snippets Groups Projects
Commit dd989546 authored by jhrdinka's avatar jhrdinka Committed by Julia Hrdinka
Browse files

Update documentation

parent 3c466252
No related branches found
No related tags found
No related merge requests found
...@@ -84,8 +84,10 @@ public: ...@@ -84,8 +84,10 @@ public:
/// Run the event loop over the given number of events. /// Run the event loop over the given number of events.
/// ///
/// @param events (optional) Number of events to process /// @param events (optional) Number of events to process
/// @note The event number is optional, for the case that a reader determines /// @note This parameter is optional when input is read from a file. In this
/// the event number /// scenario, leaving it unset will process events until the end of the file,
/// and setting it will put an upper bound on the number of events to be
/// processed.
/// @param skip Number of events to skip before processing /// @param skip Number of events to skip before processing
/// ///
/// This will run all configured algorithms for each event, potentially in /// This will run all configured algorithms for each event, potentially in
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment