diff options
author | Tinku Mannan | 2019-09-20 14:55:05 -0500 |
---|---|---|
committer | Tinku Mannan | 2019-09-20 14:55:05 -0500 |
commit | 0f716e0d81926894f3ad019b35f1154c690eb17d (patch) | |
tree | 5516e0cd67c2fde70d12844c7d85ca3d5587ed8d | |
parent | 75bf8bb0abcd3d3fc66374b4f247b4f453de446b (diff) | |
parent | e8d630263d4ff3dc34df32528becdc350bf44713 (diff) | |
download | transport-0f716e0d81926894f3ad019b35f1154c690eb17d.tar.gz transport-0f716e0d81926894f3ad019b35f1154c690eb17d.tar.xz transport-0f716e0d81926894f3ad019b35f1154c690eb17d.zip |
Merge pull request #157 in PROCESSOR-SDK/transport from WIP_nimu_doxygen to master
* commit 'e8d630263d4ff3dc34df32528becdc350bf44713':
Added doxygen groups
-rw-r--r-- | ndk/nimu/nimu_eth.h | 19 | ||||
-rw-r--r-- | ndk/nimu/src/nimu_osal.h | 13 | ||||
-rw-r--r-- | ndk/nimu/src/v7/nimu_eth.h | 12 |
3 files changed, 41 insertions, 3 deletions
diff --git a/ndk/nimu/nimu_eth.h b/ndk/nimu/nimu_eth.h index 8ed3b7d..1fdca82 100644 --- a/ndk/nimu/nimu_eth.h +++ b/ndk/nimu/nimu_eth.h | |||
@@ -35,7 +35,22 @@ | |||
35 | */ | 35 | */ |
36 | 36 | ||
37 | /** | 37 | /** |
38 | * @file nimu.h | 38 | * \defgroup TRANSPORT_NIMU_MODULE NIMU Driver |
39 | * | ||
40 | * @{ | ||
41 | */ | ||
42 | /* @} */ | ||
43 | |||
44 | /** | ||
45 | * \ingroup TRANSPORT_NIMU_MODULE | ||
46 | * \defgroup TRANSPORT_NIMU_API_MODULE NIMU Driver API | ||
47 | * This file defines the interface applications can use when | ||
48 | * integrating the Network Interface Module Ethernet driver adaptation layer | ||
49 | * @{ | ||
50 | */ | ||
51 | |||
52 | /** | ||
53 | * @file nimu/nimu_eth.h | ||
39 | * | 54 | * |
40 | * @brief | 55 | * @brief |
41 | * This file defines the interface applications can use when | 56 | * This file defines the interface applications can use when |
@@ -105,3 +120,5 @@ void Osal_nimuFree (void* dataPtr, uint32_t num_bytes); | |||
105 | #endif | 120 | #endif |
106 | 121 | ||
107 | #endif | 122 | #endif |
123 | |||
124 | /* @} */ | ||
diff --git a/ndk/nimu/src/nimu_osal.h b/ndk/nimu/src/nimu_osal.h index e5b8f9b..043f5ba 100644 --- a/ndk/nimu/src/nimu_osal.h +++ b/ndk/nimu/src/nimu_osal.h | |||
@@ -1,5 +1,14 @@ | |||
1 | /** | 1 | /** |
2 | * @file NIMU_osal.h | 2 | * \ingroup TRANSPORT_NIMU_MODULE |
3 | * \defgroup TRANSPORT_NIMU_OSAL_MODULE NIMU OSAL | ||
4 | * This is the sample OS Adaptation layer which is used by the NIMU | ||
5 | * driver. The OSAL layer can be ported in either of the following | ||
6 | * manners to a native OS: | ||
7 | * @{ | ||
8 | */ | ||
9 | |||
10 | /** | ||
11 | * @file nimu_osal.h | ||
3 | * | 12 | * |
4 | * @brief | 13 | * @brief |
5 | * This is the sample OS Adaptation layer which is used by the MMC | 14 | * This is the sample OS Adaptation layer which is used by the MMC |
@@ -307,3 +316,5 @@ extern "C" { | |||
307 | 316 | ||
308 | #endif /* NIMU_OSAL_H__ */ | 317 | #endif /* NIMU_OSAL_H__ */ |
309 | 318 | ||
319 | /* @} */ | ||
320 | |||
diff --git a/ndk/nimu/src/v7/nimu_eth.h b/ndk/nimu/src/v7/nimu_eth.h index 8f10d1e..c51dd34 100644 --- a/ndk/nimu/src/v7/nimu_eth.h +++ b/ndk/nimu/src/v7/nimu_eth.h | |||
@@ -1,5 +1,13 @@ | |||
1 | /** | 1 | /** |
2 | * @file nimu_eth.h | 2 | * \ingroup TRANSPORT_NIMU_MODULE |
3 | * \defgroup TRANSPORT_NIMU_API_V7_MODULE NIMU Driver V7 API | ||
4 | * This file defines the interface applications can use when | ||
5 | * integrating the Network Interface Module Ethernet driver adaptation layer | ||
6 | * @{ | ||
7 | */ | ||
8 | |||
9 | /** | ||
10 | * @file nimu/src/v7/nimu_eth.h | ||
3 | */ | 11 | */ |
4 | /* | 12 | /* |
5 | * Copyright (c) 2018, Texas Instruments Incorporated | 13 | * Copyright (c) 2018, Texas Instruments Incorporated |
@@ -149,3 +157,5 @@ typedef struct NIMU_PruRtuFw_s{ | |||
149 | #endif | 157 | #endif |
150 | 158 | ||
151 | #endif /* NIMU_ETH_H_ */ | 159 | #endif /* NIMU_ETH_H_ */ |
160 | |||
161 | /* @} */ | ||