Details
-
Type:
Improvement
-
Status: Done
-
Resolution: Done
-
Fix Version/s: None
-
Component/s: base
-
Labels:
-
Story Points:1
-
Epic Link:
-
Sprint:Alert Production S17 - 2
-
Team:Alert Production
Description
During review of DM-7891, Jonathan Sick said he intends for the final LSST documentation to link all mentions of API components, and requested that a style rule concerning manual links (@ref) be removed from the draft style guidelines. Without such a rule, however, current documentation will have no links at all.
Since it would be simpler to not introduce the rule now than to request/approve its removal later, the best solution is to enable Doxygen's autolinking, removing the need for @ref tags. This change should not cause compatibility problems for existing documentation that uses @ref.
Attachments
Issue Links
Activity
Field | Original Value | New Value |
---|---|---|
Epic Link |
|
Rank | Ranked higher |
Sprint | Alert Production S17 - 2 [ 361 ] |
Rank | Ranked higher |
Status | To Do [ 10001 ] | In Progress [ 3 ] |
Reviewers | Jonathan Sick [ jsick ] | |
Status | In Progress [ 3 ] | In Review [ 10004 ] |
Status | In Review [ 10004 ] | Reviewed [ 10101 ] |
Resolution | Done [ 10000 ] | |
Status | Reviewed [ 10101 ] | Done [ 10002 ] |
Labels | SciencePipelines Standards documentation, | SciencePipelines Standards documentation documentation, |
Labels | SciencePipelines Standards documentation documentation, | SciencePipelines Standards documentation |
Hi Jonathan Sick, please confirm this (one-line) change to the Doxygen settings.