From 222f309be529285683c707caee934b48d8cd75cd Mon Sep 17 00:00:00 2001 From: Mathieu Lacage Date: Mon, 14 May 2007 12:37:31 +0200 Subject: [PATCH] more dox doc --- src/applications/onoff-application.h | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/src/applications/onoff-application.h b/src/applications/onoff-application.h index c8e88831f..f41aa18b4 100644 --- a/src/applications/onoff-application.h +++ b/src/applications/onoff-application.h @@ -42,7 +42,12 @@ class DataRate; * \brief Generate traffic to a single destination according to an * OnOff pattern. * - * + * This traffic follows an On/Off pattern: after Application::StartApplication + * is called, "On" and "Off" states alternate. The duration of each of + * these states is determined with the onTime and the offTime random + * variables. During the "Off" state, no traffic is generated. + * During the "On" state, cbr traffic is generated. This cbr traffic is + * characterized by the specified "data rate" and "packet size". */ class OnOffApplication : public Application {