Skip to content

Commit

Permalink
doc: Fix doxygen group closings
Browse files Browse the repository at this point in the history
To close a group, the @} string must appear in a comment that is parsed by
Doxygen, i.e. inside a comment that starts with a "/**".

Signed-off-by: Petr Tesarik <[email protected]>
  • Loading branch information
ptesarik committed Jan 2, 2025
1 parent 23bac29 commit 3fcff04
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion include/libkdumpfile/addrxlat.h.in
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ typedef uint_fast64_t addrxlat_pte_t;
#define ADDRXLAT_PRIuPTE PRIuFAST64 /**< Decimal PTE */
#define ADDRXLAT_PRIxPTE PRIxFAST64 /**< Lowercase hex PTE */
#define ADDRXLAT_PRIXPTE PRIXFAST64 /**< Uppercase hex PTE */
/* @} */
/** @} */

/** Address spaces
*
Expand Down
8 changes: 4 additions & 4 deletions include/libkdumpfile/kdumpfile.h.in
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ typedef uint_fast64_t kdump_num_t;
#define KDUMP_PRIuNUM PRIuFAST64 /**< Decimal @c kdump_num_t */
#define KDUMP_PRIxNUM PRIxFAST64 /**< Lowercase hex @c kdump_num_t */
#define KDUMP_PRIXNUM PRIXFAST64 /**< Uppercase hex @c kdump_num_t */
/* @} */
/** @} */

/** Type of a physical or virtual address.
*
Expand Down Expand Up @@ -118,7 +118,7 @@ typedef kdump_addr_t kdump_vaddr_t;
#define KDUMP_PRIuADDR ADDRXLAT_PRIuADDR /**< Decimal address */
#define KDUMP_PRIxADDR ADDRXLAT_PRIxADDR /**< Lowercase hex address */
#define KDUMP_PRIXADDR ADDRXLAT_PRIXADDR /**< Uppercase hex address */
/* @} */
/** @} */

/** Representation of a dump file.
*
Expand Down Expand Up @@ -217,7 +217,7 @@ enum kdump_clone_bits {
*/
/** Do not share address translation. */
#define KDUMP_CLONE_XLAT (1UL << KDUMP_CLONE_BIT_XLAT)
/* @} */
/** @} */

/** Clone a dump file object.
* @param orig Original dump file object.
Expand Down Expand Up @@ -1034,7 +1034,7 @@ void kdump_attr_iter_end(kdump_ctx_t *ctx, kdump_attr_iter_t *iter);
#define KDUMP_ARCH_S390 "s390" /**< IBM z/Architecture, 31-bit */
#define KDUMP_ARCH_S390X "s390x" /**< IBM z/Architecture, 64-bit */
#define KDUMP_ARCH_X86_64 "x86_64" /**< AMD64, Intel 64 */
/* @} */
/** @} */

/** Byte order attribute.
* @sa kdump_byte_order_t
Expand Down

0 comments on commit 3fcff04

Please sign in to comment.