Uploaded image for project: 'WiredTiger'
  1. WiredTiger
  2. WT-8024

Add link text to cross-references in Arch Guide

    XMLWordPrintable

    Details

    • Type: Documentation
    • Status: Closed
    • Priority: Minor - P4
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: WT10.0.1, 5.0.4, 4.4.10, 5.1.0-rc0
    • Component/s: None
    • Labels:
      None

      Description

      Many places in the architecture guide use the following style for cross-references to other pages of the guide:

       

      See @ref arch-cache for more information.

      Doxygen turns this into a link that uses the title of the target page as the link text:

       

      See Cache (Architecture Guide) for more information.

      The parenthetical "(Architecture Guide)" is awkward.  We should update these links to provide better text.  For example using the following style in Doxygen:

       

      See @ref arch-cache "Cache" for more information.
      

      This will produce:

       

      See Cache for more information.

      It would be even easier if there is a way create a page that has one string that is displayed as its title and a different string that is displayed as link text. 

        Attachments

          Activity

            People

            Assignee:
            keith.smith Keith Smith
            Reporter:
            keith.smith Keith Smith
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved: