Enhancement: Improve doxygen comment readability

[GoogleCodeExporter]

It is understood that the label of an arc of an MSC is important for an user 
who just reads the doxygen comment containing the MSC. To enhance the 
readability of the label, we may probably use a three column view as given 
below. Second column contains the label and third column contains other 
attributes.

msc {

A [label="client"],
B [label="server"];

A => B     [label="Request",                  textcolor=red];

A << B     [label="This is a big line of
                   text indicating that
                   this arc is a response",   url="www.google.com"];

A =>> B    [label="Notification"];
}

Still it is possible to make it better by changing the parser a little to parse 
the syntax given below.

msc {

A [label="client"],
B [label="server"];

A => B     "Request"                  [textcolor=red];

A << B     "This is a big line of
            text indicating that
            this arc is a response"   [url="www.google.com"];

A =>> B    "Notification";
}

A patch is attached which will change parser to do this.

Cons to consider:

In future, new commands could be added whose right side entity name can either 
be present or absent and not optional e.g. in "A (NEWCMD) B", "B" cannot be 
optional. If it has to be optional, then context dependent parsing will be 
required.

Original issue reported on code.google.com by arunmozh...@gmail.com on 9 Oct 2010 at 5:10

Attachments:

• Patch.patch

[GoogleCodeExporter]

Hmm.  The current syntax was made because it is similar to the Graphviz dot 
syntax which people may have already been using under Doxygen.  

Original comment by Michael....@gmail.com on 9 Oct 2010 at 5:43

[GoogleCodeExporter]

Original comment by Michael....@gmail.com on 2 Nov 2010 at 9:13

• Changed state: WontFix