[ doc ] add documentation

idris-lang · Aug 18, 2024 · dc042ab · dc042ab
1 parent bf1c245
commit dc042ab
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/libs/base/System/Signal.idr b/libs/base/System/Signal.idr
@@ -105,6 +105,8 @@ Eq Signal where
   SigPosix x == SigPosix y = x == y
   _ == _ = False
 
+||| Converts a `Signal` to its integer representation to be used
+||| in FFI calls.
 export
 signalCode : Signal -> Int
 signalCode SigINT   = prim__sigint
@@ -118,6 +120,7 @@ signalCode (SigPosix SigTRAP ) = prim__sigtrap
 signalCode (SigPosix SigUser1) = prim__sigusr1
 signalCode (SigPosix SigUser2) = prim__sigusr2
 
+||| Tries to convert an integer to the corresponding `Signal`.
 export
 toSignal : Int -> Maybe Signal
 toSignal (-1) = Nothing