Links to Jira from source code via Doxygen

Aaron.Ridout August 23, 2022

I would like to be able to put links to our Jira items in the src code, especially when the changes are not obvious and also for when there is work to do in the future. E.g.

/** GEOD-72 This code waits for the response before calculating the number of widgets we have left */
size_t waitToCalculateWidgetsRemaining();

Alternatively as part of a @todo comment, e.g.

///< @todo GEOD-123 overload testRunEnded() here to get the number of unit tests executed 

I realize I could use embedded HTML, like  

///< @todo <a href="https://foo.atlassian.net/browse/GEOD-131">GEOD-131</a> overload Event testRunEnded() ...

but has anyone created a short-cut mechanism in Doxygen so we dont have to repeat the url every time?

0 answers

Suggest an answer

Log in or Sign up to answer
DEPLOYMENT TYPE
CLOUD
PRODUCT PLAN
PREMIUM
TAGS
AUG Leaders

Atlassian Community Events