New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Can't use @ref instead of \ref with msc (Origin: bugzilla #703213) #5226

Closed
doxygen opened this Issue Jul 2, 2018 · 0 comments

Comments

Projects
None yet
1 participant
@doxygen
Owner

doxygen commented Jul 2, 2018

status RESOLVED severity minor in component general for ---
Reported in version 1.8.4 on platform Other
Assigned to: Dimitri van Heesch

On 2013-06-27 19:37:37 +0000, Gre7g Luterman wrote:

I'm documenting Python code, so I'm using @ notation instead of . However @ref in an msc definition doesn't work.

The doc snippet:

@msc

U [label=User], M [label=Metaserver], H [label="Hostserver 1"],

a [label="Node 1a"];

U->M [label="connectRq()", URL="@ref rpcDox.Metaserver.connectRq()"];

U<-M [label="connectRs()", URL="@ref rpcDox.User.connectRs()"];

U->M [label="loginRq()", URL="@ref rpcDox.Metaserver.loginRq()"];

...

Generates HTML:

msc_inline_mscgraph_1 ...

Note the @ref as the URL and the crazy coordinate in the tags.

But changing @ref to \ref:

@msc

U [label=User], M [label=Metaserver], H [label="Hostserver 1"],

a [label="Node 1a"];

U->M [label="connectRq()", URL="\ref rpcDox.Metaserver.connectRq()"];

U<-M [label="connectRs()", URL="\ref rpcDox.User.connectRs()"];

U->M [label="loginRq()", URL="\ref rpcDox.Metaserver.loginRq()"];

...

Produces sane output:

msc_inline_mscgraph_1 ...

Note how the URLs are valid and the coordinates are reasonable.

On 2013-06-30 10:22:00 +0000, Dimitri van Heesch wrote:

This is an issue in mscgen really. It supports \ref but not @ref.
You may want to request the author of mscgen to add this.

On 2013-07-01 13:16:30 +0000, Gre7g Luterman wrote:

I disagree. I don't believe it's an mscgen issue. I made two versions of an input file; one that starts with:

msc {
U [label=User], M [label=Metaserver], H [label="Hostserver 1"],
a [label="Node 1a"];
U->M [label="connectRq()", URL="@ref rpcDox.Metaserver.connectRq()"];
U<-M [label="connectRs()", URL="@ref rpcDox.User.connectRs()"];
U->M [label="loginRq()", URL="@ref rpcDox.Metaserver.loginRq()"];
...

and one that starts with:

msc {
U [label=User], M [label=Metaserver], H [label="Hostserver 1"],
a [label="Node 1a"];
U->M [label="connectRq()", URL="\ref rpcDox.Metaserver.connectRq()"];
U<-M [label="connectRs()", URL="\ref rpcDox.User.connectRs()"];
U->M [label="loginRq()", URL="\ref rpcDox.Metaserver.loginRq()"];
...

When I ran them through mscgen, I get output that starts with:

rect @ref rpcDox.Metaserver.connectRq() 111,26 190,39
rect @ref rpcDox.User.connectRs() 111,58 189,71
rect @ref rpcDox.Metaserver.loginRq() 121,90 180,103
...

and:

rect \ref rpcDox.Metaserver.connectRq() 111,26 190,39
rect \ref rpcDox.User.connectRs() 111,58 189,71
rect \ref rpcDox.Metaserver.loginRq() 121,90 180,103
...

respectively.

In other words, mscgen's behavior is consistent, but doxygen's treatment of this output is not.

On 2013-07-02 14:15:11 +0000, Dimitri van Heesch wrote:

Confirmed. I overlooked one place where \ref is indeed hardcoded. Should be fixed in the next GIT update.

On 2013-08-23 15:04:36 +0000, Dimitri van Heesch wrote:

This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.8.5. Please verify if this is indeed the case. Reopen the
bug if you think it is not fixed and please include any additional information
that you think can be relevant.

@doxygen doxygen closed this Jul 2, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment