Author: derek Date: Sat Oct 28 03:42:51 2006 New Revision: 153 Modified: sofaswitch/trunk/callflow/src/dnd.h Log: Reformat the list of kinds to a better syle of commenting for doxygen and readability. Modified: sofaswitch/trunk/callflow/src/dnd.h ============================================================================== --- sofaswitch/trunk/callflow/src/dnd.h (original) +++ sofaswitch/trunk/callflow/src/dnd.h Sat Oct 28 03:42:51 2006 @@ -250,28 +250,28 @@ /**The currently defined shapes that we can draw */ enum Kind { - /* 0 */ None /**The default kind, which is a placeholder, and is no shape at all */, - /* 1 */ StartHere, /**Start processing here */ - /* 2 */ EndHere, /**Finish processing here */ - /* 3 */ StartFor /**Start of a for loop */, - /* 4 */ EndFor /**End of a for loop */, - /* 5 */ Conditional /**An If statement. This is the beginning - the end is handled by joining wires. */, - /* 6 */ MakeCall /**Get a call started. In other words, start calling some entity outside of the building*/, - /* 7 */ EndCall /**End a call. In other words, send a hangup message to the node */, - /* 8 */ Select /**Used to indicate the rectangle on the screen we are selecting */, - /* 9 */ JoinBlocks /**The multi line segment shape which joins two structures on the screen */, - /* 10*/ Python /**The user can enter arbitary python here */, - /* 11*/ RequestNode /**Query a supervisor for a node to use to talk on*/, - /**12*/ Timer /**Initiate a timer, which runs for some specified time interval */, - /**13*/ StopTimer /**Stop a running timer, so it will not generate an event etc */, - /**14*/ Eventer /**Mark me as registering for an event. Possibly, wait for the registered for event */, - /**15*/ TransferMedia /**Transfer media from one sofaswitch entity to another */, - /**16*/ ReadFromFile /**Read audio from a .wav file (answering machine specific) */, - /**17*/ WriteToFile /**Write audio into a .wav file (answering machine specific) */, - /**18*/ LoadNewGraph /**Read in an existing graph file (pre compiled) for a new thread of exeuction */, - /**19*/ SendDtmf /**Send a dtmf symbol to some sofaswitch worker node */, - /**20*/ Death /**End all processing of this call flow now */, - /* 21*/ KnownShapes /**Indicates the number of known shapes we can manage */ + None = 0, /*!< The default kind, which is a placeholder, and is no shape at all */ + StartHere = 1, /*!< Start processing here */ + EndHere = 2, /*!< Finish processing here */ + StartFor = 3, /*!< Start of a for loop */ + EndFor = 4, /*!< End of a for loop */ + Conditional = 5, /*!< An If statement. This is the beginning - the end is handled by joining wires. */ + MakeCall = 6, /*!< Get a call started. In other words, start calling some entity outside of the building*/ + EndCall = 7, /*!< End a call. In other words, send a hangup message to the node */ + Select = 8, /*!< Used to indicate the rectangle on the screen we are selecting */ + JoinBlocks = 9, /*!< The multi line segment shape which joins two structures on the screen */ + Python = 10, /*!< The user can enter arbitary python here */ + RequestNode = 11, /*!< Query a supervisor for a node to use to talk on*/ + Timer = 12, /*!< Initiate a timer, which runs for some specified time interval */ + StopTimer = 13, /*!< Stop a running timer, so it will not generate an event etc */ + Eventer = 14, /*!< Mark me as registering for an event. Possibly, wait for the registered for event */ + TransferMedia= 15, /*!< Transfer media from one sofaswitch entity to another */ + ReadFromFile = 16, /*!< Read audio from a .wav file (answering machine specific) */ + WriteToFile = 17, /*!< Write audio into a .wav file (answering machine specific) */ + LoadNewGraph = 18, /*!< Read in an existing graph file (pre compiled) for a new thread of exeuction */ + SendDtmf = 19, /*!< Send a dtmf symbol to some sofaswitch worker node */ + Death = 20, /*!< End all processing of this call flow now */ + KnownShapes = 21 /*!< Indicates the number of known shapes we can manage */ }; /**Constructor to a predefined shape */