Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enable typedef to make docs able to link *_t structs. #185

Merged
merged 1 commit into from
Dec 10, 2024
Merged

Enable typedef to make docs able to link *_t structs. #185

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/doxygen/config.doxyfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -299,7 +299,7 @@ ALIASES = "dependencies_section{1}=@section \1_dependencies Depen
"enums_brief{1}=@brief Enumerated types of the \1." \
"functionpointers_group{2}=@defgroup \1_datatypes_functionpointers \2 Function pointer types" \
"functionpointers_brief{1}=@brief Function pointer types of the \1." \
"structs_group{21}=@defgroup \1_datatypes_structs \2 Structured types" \
"structs_group{2}=@defgroup \1_datatypes_structs \2 Structured types" \
"structs_brief{1}=@brief Structured types of the \1." \
"paramstructs_group{2}=@defgroup \1_datatypes_paramstructs \2 Parameter structures" \
"paramstructs_brief{2}=@brief Structures passed as parameters to [\2 functions](@ref \1_functions)<br>These structures are passed as parameters to library functions. Documentation for these structures will state the functions associated with each parameter structure and the purpose of each member." \
Expand Down Expand Up @@ -478,7 +478,7 @@ INLINE_SIMPLE_STRUCTS = NO
# types are typedef'ed and only the typedef is referenced, never the tag name.
# The default value is: NO.

TYPEDEF_HIDES_STRUCT = YES
TYPEDEF_HIDES_STRUCT = NO

# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
# cache is used to resolve symbols given their name and scope. Since this can be
Expand Down
10 changes: 10 additions & 0 deletions docs/doxygen/pages.dox
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -404,6 +404,11 @@ void PlatformMutex_Unlock( PlatformMutex_t * pMutex );
```
*/

/**
* @structs_group{cellular,Cellular}
* @structs_brief{cellular,cellular}
*/

/**
* @paramstructs_group{cellular,Cellular}
* @paramstructs_brief{cellular,cellular}
Expand All @@ -423,3 +428,8 @@ void PlatformMutex_Unlock( PlatformMutex_t * pMutex );
* @enums_group{cellular,Cellular}
* @enums_brief{cellular library}
*/

/**
* @common_datatypes_paramstructs_group{cellular,Cellular}
* @common_datatypes_paramstructs_brief{cellular library}
*/
4 changes: 0 additions & 4 deletions source/include/cellular_types.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,10 +54,6 @@
*/
#define CELLULAR_INVALID_SIGNAL_BAR_VALUE ( 0xFFU )

/**
* @ingroup cellular_datatypes_handles
* @brief Opaque Cellular context structure.
*/
struct CellularContext;

/**
Expand Down
10 changes: 5 additions & 5 deletions source/include/common/cellular_common.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
/*-----------------------------------------------------------*/

/**
* @ingroup cellular_common_datatypes_paramstructs
* @ingroup cellular_datatypes_paramstructs
* @brief The AT command request structure.
*/
typedef struct CellularAtReq
Expand All @@ -69,7 +69,7 @@ typedef struct CellularAtReq
} CellularAtReq_t;

/**
* @ingroup cellular_common_datatypes_paramstructs
* @ingroup cellular_datatypes_paramstructs
* @brief The data command request structure.
*/
typedef struct CellularAtDataReq
Expand All @@ -94,7 +94,7 @@ typedef void ( * CellularAtParseTokenHandler_t )( CellularContext_t * pContext,
char * pInputStr );

/**
* @ingroup cellular_common_datatypes_paramstructs
* @ingroup cellular_datatypes_paramstructs
* @brief the URC token and URC handler mapping structure used by pkthandler.
*/
typedef struct CellularAtParseTokenMap
Expand All @@ -116,7 +116,7 @@ typedef enum CellularSocketState
} CellularSocketState_t;

/**
* @ingroup cellular_common_datatypes_paramstructs
* @ingroup cellular_datatypes_paramstructs
* @brief Parameters involved in sending/receiving data through sockets.
*/
typedef struct CellularSocketContext
Expand Down Expand Up @@ -151,7 +151,7 @@ typedef struct CellularSocketContext
} CellularSocketContext_t;

/**
* @ingroup cellular_common_datatypes_paramstructs
* @ingroup cellular_datatypes_paramstructs
* @brief Parameters to setup pktio and pkthandler token tables.
*/
typedef struct CellularTokenTable
Expand Down
1 change: 1 addition & 0 deletions source/interface/cellular_comm_interface.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,7 @@ typedef CellularCommInterfaceError_t ( * CellularCommInterfaceRecv_t )( Cellular
typedef CellularCommInterfaceError_t ( * CellularCommInterfaceClose_t )( CellularCommInterfaceHandle_t commInterfaceHandle );

/**
* @ingroup cellular_datatypes_paramstructs
* @brief Represents the functions of a comm interface.
*
* Functions of these signature should be implemented against a comm interface
Expand Down
Loading