Question

I have a aliased command that I'm using to generate an xrefitem page in my doxygen configuration.

ALIASES += "satisfy{2}=\xrefitem satisfy \"Satisfies\" \"Bottom up traceability\" requirement \1 in section: \ref \2"

If I want a second configuration that does not generate this page, and take out that alias I'm going to get a warning:

Warning: Found unknown command `\satisfy'

Is there a different alias I could enter that makes an essentially noop command?

I tried:

ALIASES += "satisfy{2}= \ref \2 Satisfies requirement \1

And:

ALIASES += "satisfy{2}= Satisfies requirement

But this resulted in the output just echoing the arguments.

{1114,intro1}

Any suggestions? Looking at the documentation for ALIASES, I'm not even sure how the original alias parameters work, the \1, \2 syntax isn't documented there.

Was it helpful?

Solution 2

I just had the syntax wrong. Note the missing close quotes in the samples in my question.

Noop:

ALIASES +=    "satisfy{2}="

If you want plain text output:

ALIASES +=    "satisfy{2}=\2 satisfies \1"

OTHER TIPS

Just to be clear I'm understanding the question. You have in your code text like \satisfy Foo Bah. In the configuration without the xrefitem, you are still parsing the text but don't have the alias defined?

I believe you can have overloaded aliases, so does defining the following (with no parameters) help?

ALIASES += satisfy="Satisfies"

...but I'm unsure what you want to happen with the parameters in the non-cross-referenced case.

Alternatively, as written, I think you may have a typo (location of ") in the syntax of your later ALIAS definitions. I'd have expected:

ALIASES += satisfy{2}="\ref \2 Satisfies requirement \1"

Another alternative might be to define a NOOP with another alias:

ALIASES += noop{1}="\cond \1 \endcond"

or simply

ALIASES += satisfy{2}="\cond \2 \1 \endcond"

Licensed under: CC-BY-SA with attribution
Not affiliated with StackOverflow
scroll top