patrick/zephyr
1
0
Fork 0
Code Issues Pull requests Actions 7 Packages Projects Releases Wiki Activity

lib: os: doc: Cleanup doxygen groups

Browse source 
Cleaned up doxygen group for hash_map and hash_map_api
Adding brief/desc to the main group instead of the file to actually
surface them in the documentation

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
This commit is contained in:
Benjamin Cabé 2023-07-19 13:12:22 +02:00 committed by Maureen Helm
parent 1539c1c094
commit ea1e6b59f5
2 changed files with 8 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
include/zephyr/sys/hash_map.h
View file

@ -6,10 +6,8 @@
/**
* @file
* @brief Hashmap (Hash Table) API
*
* Hashmaps (a.k.a Hash Tables) sacrifice space for speed. All operations
* on a Hashmap (insert, delete, search) are O(1) complexity (on average).
* @addtogroup hashmap_apis
* @{
*/
#ifndef ZEPHYR_INCLUDE_SYS_HASH_MAP_H_
@ -29,11 +27,6 @@
extern "C" {
#endif
/**
* @ingroup hashmap_apis
* @{
*/
/**
* @brief Declare a Hashmap (advanced)
*

14
include/zephyr/sys/hash_map_api.h
View file

@ -4,14 +4,6 @@
* SPDX-License-Identifier: Apache-2.0
*/
/**
* @file
* @brief Hashmap (Hash Table) API
*
* Hashmaps (a.k.a Hash Tables) sacrifice space for speed. All operations
* on a Hashmap (insert, delete, search) are O(1) complexity (on average).
*/
#ifndef ZEPHYR_INCLUDE_SYS_HASHMAP_API_H_
#define ZEPHYR_INCLUDE_SYS_HASHMAP_API_H_
@ -27,9 +19,15 @@ extern "C" {
#endif
/**
* @file
* @defgroup hashmap_apis Hashmap
* @ingroup datastructure_apis
*
* @brief Hashmap (Hash Table) API
*
* Hashmaps (a.k.a Hash Tables) sacrifice space for speed. All operations
* on a Hashmap (insert, delete, search) are O(1) complexity (on average).
*
* @defgroup hashmap_implementations Hashmap Implementations
* @ingroup hashmap_apis
*