Skip to content

Commit

Permalink
Use correct documentation comments style
Browse files Browse the repository at this point in the history
  • Loading branch information
bamx23 committed Nov 5, 2024
1 parent 96f29dd commit 0236bf0
Showing 1 changed file with 10 additions and 7 deletions.
17 changes: 10 additions & 7 deletions Sources/KSCrashCore/include/KSCompilerDefines.h
Original file line number Diff line number Diff line change
Expand Up @@ -27,17 +27,20 @@
#ifndef HDR_KSCompilerDefines_h
#define HDR_KSCompilerDefines_h

/// Disables optimisations to ensure a function remains in stacktrace.
/// Usually used in pair with `KS_THWART_TAIL_CALL_OPTIMISATION`.
/** Disables optimisations to ensure a function remains in stacktrace.
* Usually used in pair with `KS_THWART_TAIL_CALL_OPTIMISATION`.
*/
#define KS_KEEP_FUNCTION_IN_STACKTRACE __attribute__((disable_tail_calls))

/// Disables inline optimisation.
/// Usually used in pair with `KS_KEEP_FUNCTION_IN_STACKTRACE`.
/** Disables inline optimisation.
* Usually used in pair with `KS_KEEP_FUNCTION_IN_STACKTRACE`.
*/
#define KS_NOINLINE __attribute__((noinline))

/// Extra safety measure to ensure a method is not tail-call optimised.
/// This define should be placed at the end of a function.
/// Usually used in pair with `KS_KEEP_FUNCTION_IN_STACKTRACE`.
/** Extra safety measure to ensure a method is not tail-call optimised.
* This define should be placed at the end of a function.
* Usually used in pair with `KS_KEEP_FUNCTION_IN_STACKTRACE`.
*/
#define KS_THWART_TAIL_CALL_OPTIMISATION __asm__ __volatile__("");

#endif // HDR_KSCompilerDefines_h

0 comments on commit 0236bf0

Please sign in to comment.