Uploaded image for project: 'Embedded Software & Tools'
  1. Embedded Software & Tools
  2. EXT_EP-9870

HCI and Micro Stack doxygen has unworking links into User's Guide

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Fixed
    • Icon: Low Low
    • SimpleLink CC13x2-26x2 SDK BLE5 Stack
    • BLE_AGAMA-1454
    • BLE Stack BLE5-2.1.0
    • Hide
      BLE Stack BLE5-2.1.3 RC1
      BLE Stack BLE5-2.1.3
      Show
      BLE Stack BLE5-2.1.3 RC1 BLE Stack BLE5-2.1.3

      The introductory text in doxygen for hci.h and uble.h has relative links back to the BLE-Stack User's Guide. These links are broken and not working on the BLE5-Stack for cc13x2_26x2.

      (CC2640R2 may be affected as well). In general we should not link from the doxygen back to the user's guide to prevent broken links like this. Remove the links and just use the text instead

      For example from hci.h

       *  @defgroup HCI HCI
       *  @brief This module implements the Host Controller Interface.
       *  For a detailed usage section describing how to send these commands and receive events,
       *  see the <a href="../ble-stack/hci.html">HCI Section</a> of the
       *  User's Guide.
      

      In the text above, <a href="../ble-stack/hci.html">HCI Section</a> should be removed and replaced with "see the HCI section of the user's guide" or something similar.

            syncuser TI User
            syncuser TI User
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: