Skip to content

Commit

Permalink
docs: Updates
Browse files Browse the repository at this point in the history
Signed-off-by: Ben Collins <[email protected]>
  • Loading branch information
benmcollins committed Jan 7, 2025
1 parent 4c1e523 commit 2f1a29e
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 6 deletions.
2 changes: 1 addition & 1 deletion cmake/LibJWTDoxyfile.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ set(a_pre_b "<a type=\\\"button\\\" class=\\\"button\\\" target=\\\"_blank\\\" h

# Used for easily linking to RFC and RFC sections
set(DOXYGEN_ALIASES "rfc{1}=\"${fa_i} ${a_pre}\\1\\\">RFC-\\1</a>\"")
string(APPEND DOXYGEN_ALIASES " \\\n\trfc{2}=\"${fa_i} ${a_pre_b}\\1#section-\\2\\\">RFC-\\1 Sec \\2</a>\"")
string(APPEND DOXYGEN_ALIASES " \\\n\trfc{2}=\"${a_pre_b}\\1#section-\\2\\\">RFC-\\1 Sec \\2</a>\"")
string(APPEND DOXYGEN_ALIASES " \\\n\trfc_t{2}=\"${fa_i} ${a_pre}\\1#section-\\2\\\">RFC-\\1 Sec \\2</a>\"")

set(DOXYGEN_VERBATIM_VARS DOXYGEN_EXAMPLE_PATTERNS DOXYGEN_PREDEFINED
Expand Down
19 changes: 14 additions & 5 deletions include/jwt.h
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ typedef enum {
* Corresponds to the ``"kty"`` attribute of the JWK.
*
* @rfc{7517,4.1}
* @rfc(7518,6.1}
* @rfc{7518,6.1}
*/
typedef enum {
JWK_KEY_TYPE_NONE = 0, /**< Unused on valid keys */
Expand Down Expand Up @@ -389,7 +389,9 @@ typedef int (*jwt_callback_t)(const jwt_t *, jwt_config_t *);
*/

/**
* @defgroup jwt_create_grp Create a JWT
* @defgroup jwt_create_grp Creation
*
* @raisewarning Complete overview of JWT create group
* @{
*/

Expand All @@ -407,9 +409,12 @@ jwt_t *jwt_create(jwt_config_t *config);
*/

/**
* @defgroup jwt_verify_grp Token Verification
* @defgroup jwt_verify_grp Verification
*
* LibJWT provides mechanisms to verify a JWT including the signature block.
* Many aspects of this verification are defined by the relevant RFCs.
*
* @raisewarning Complete the details of this information
* @raisewarning Need more indepth information
*
* @{
*/
Expand Down Expand Up @@ -1196,7 +1201,11 @@ void jwks_free(jwk_set_t *jwk_set);

#if defined(__GNUC__) || defined(__clang__)
/**
* @raisewarning Document jwks_freep
* @brief Helper function to free a JWK Set and set the pointer to NULL
*
* This is mainly to use with the jwt_set_auto_t type.
*
* @param Pointer to a pointer for a jwt_set_t object
*/
static inline void jwks_freep(jwk_set_t **jwks) {
if (jwks) {
Expand Down

0 comments on commit 2f1a29e

Please sign in to comment.