diff options
| author | Chris Kay <chris.kay@arm.com> | 2020-09-28 12:46:28 +0100 |
|---|---|---|
| committer | jimqui01 <54316584+jimqui01@users.noreply.github.com> | 2020-10-02 14:19:09 +0100 |
| commit | cbbf44b6061ef610ddf04fb7bc002e5c3c6c2f16 (patch) | |
| tree | a57d35a8dcf6829ef852187e8dec1af4078d2543 /product/morello | |
| parent | 691839e0c23cd6b836a39029e0639b9f62d6b46a (diff) | |
docs: Replace `\ref` with `::`
The code-base is currently fairly inconsistent with its usage of the
`::` prefix and the `\ref`. This commit replaces any instances of `\ref`
with `::`.
Change-Id: I02c1b6e2caf0f333388f44ac51ede060aa0568c3
Signed-off-by: Chris Kay <chris.kay@arm.com>
Diffstat (limited to 'product/morello')
| -rw-r--r-- | product/morello/module/cmn_skeena/include/mod_cmn_skeena.h | 10 |
1 files changed, 4 insertions, 6 deletions
diff --git a/product/morello/module/cmn_skeena/include/mod_cmn_skeena.h b/product/morello/module/cmn_skeena/include/mod_cmn_skeena.h index b33145ac..e981da40 100644 --- a/product/morello/module/cmn_skeena/include/mod_cmn_skeena.h +++ b/product/morello/module/cmn_skeena/include/mod_cmn_skeena.h @@ -94,10 +94,8 @@ struct mod_cmn_skeena_memory_region_map { /*! * \brief Target node identifier * - * \note Not used for \ref - * mod_cmn_skeena_memory_region_type.MOD_CMN_SKEENA_MEMORY_REGION_TYPE_SYSCACHE - * memory regions as it uses the pool of HN-F nodes available in the - * system + * \note Not used for ::MOD_CMN_SKEENA_MEMORY_REGION_TYPE_SYSCACHE memory + * regions as it uses the pool of HN-F nodes available in the system. */ unsigned int node_id; }; @@ -127,7 +125,7 @@ struct mod_cmn_skeena_config { */ const unsigned int *snf_table; - /*! Number of entries in the \ref snf_table */ + /*! Number of entries in the ::mod_cmn_skeena_config::snf_table */ size_t snf_count; /*! Host SA count */ @@ -136,7 +134,7 @@ struct mod_cmn_skeena_config { /*! Table of region memory map entries */ const struct mod_cmn_skeena_memory_region_map *mmap_table; - /*! Number of entries in the \ref mmap_table */ + /*! Number of entries in the ::mod_cmn_skeena_config::mmap_table */ size_t mmap_count; /*! Address space of the chip */ |