From b7fa405365c43fc2d45e37385ffd0111a4008eed Mon Sep 17 00:00:00 2001 From: Herbert Valerio Riedel Date: Tue, 19 Apr 2016 19:37:41 +0200 Subject: Convert /since/ to @since syntax --- System/Posix/Fcntl.hsc | 8 ++++---- System/Posix/Files.hsc | 6 +++--- System/Posix/Files/Common.hsc | 4 ++-- System/Posix/Process/Common.hsc | 2 +- System/Posix/Process/Internals.hs | 2 +- System/Posix/Signals.hsc | 8 ++++---- System/Posix/Unistd.hsc | 4 ++-- 7 files changed, 17 insertions(+), 17 deletions(-) diff --git a/System/Posix/Fcntl.hsc b/System/Posix/Fcntl.hsc index 2d8ef12..c78f361 100644 --- a/System/Posix/Fcntl.hsc +++ b/System/Posix/Fcntl.hsc @@ -16,7 +16,7 @@ -- -- POSIX file control support -- --- /Since: 2.7.1.0/ +-- @since 2.7.1.0 ----------------------------------------------------------------------------- #include "HsUnix.h" @@ -44,7 +44,7 @@ import GHC.IO.Exception ( unsupportedOperation ) -- -- For more details, see documentation of @posix_fadvise(2)@. -- --- /Since: 2.7.1.0/ +-- @since 2.7.1.0 data Advice = AdviceNormal | AdviceRandom @@ -61,7 +61,7 @@ data Advice -- -- (use @#if HAVE_POSIX_FADVISE@ CPP guard to detect availability) -- --- /Since: 2.7.1.0/ +-- @since 2.7.1.0 fileAdvise :: Fd -> FileOffset -> FileOffset -> Advice -> IO () #if HAVE_POSIX_FADVISE fileAdvise fd off len adv = do @@ -88,7 +88,7 @@ fileAdvise _ _ _ _ = return () -- -- (use @#if HAVE_POSIX_FALLOCATE@ CPP guard to detect availability). -- --- /Since: 2.7.1.0/ +-- @since 2.7.1.0 fileAllocate :: Fd -> FileOffset -> FileOffset -> IO () #if HAVE_POSIX_FALLOCATE fileAllocate fd off len = do diff --git a/System/Posix/Files.hsc b/System/Posix/Files.hsc index 7c637cc..bbda084 100644 --- a/System/Posix/Files.hsc +++ b/System/Posix/Files.hsc @@ -347,7 +347,7 @@ setFileTimes name atime mtime = do -- -- Note: calls @utimensat@ or @utimes@. -- --- /Since: 2.7.0.0/ +-- @since 2.7.0.0 setFileTimesHiRes :: FilePath -> POSIXTime -> POSIXTime -> IO () #ifdef HAVE_UTIMENSAT setFileTimesHiRes name atime mtime = @@ -368,7 +368,7 @@ setFileTimesHiRes name atime mtime = -- -- Note: calls @utimensat@ or @lutimes@. -- --- /Since: 2.7.0.0/ +-- @since 2.7.0.0 setSymbolicLinkTimesHiRes :: FilePath -> POSIXTime -> POSIXTime -> IO () #if HAVE_UTIMENSAT setSymbolicLinkTimesHiRes name atime mtime = @@ -402,7 +402,7 @@ touchFile name = do -- -- Note: calls @lutimes@. -- --- /Since: 2.7.0.0/ +-- @since 2.7.0.0 touchSymbolicLink :: FilePath -> IO () #if HAVE_LUTIMES touchSymbolicLink name = diff --git a/System/Posix/Files/Common.hsc b/System/Posix/Files/Common.hsc index a1a4278..cc594cc 100644 --- a/System/Posix/Files/Common.hsc +++ b/System/Posix/Files/Common.hsc @@ -467,7 +467,7 @@ foreign import ccall unsafe "futimes" -- -- Note: calls @futimens@ or @futimes@. -- --- /Since: 2.7.0.0/ +-- @since 2.7.0.0 setFdTimesHiRes :: Fd -> POSIXTime -> POSIXTime -> IO () #if HAVE_FUTIMENS setFdTimesHiRes (Fd fd) atime mtime = @@ -488,7 +488,7 @@ setFdTimesHiRes = -- -- Note: calls @futimes@. -- --- /Since: 2.7.0.0/ +-- @since 2.7.0.0 touchFd :: Fd -> IO () #if HAVE_FUTIMES touchFd (Fd fd) = diff --git a/System/Posix/Process/Common.hsc b/System/Posix/Process/Common.hsc index 59212e4..7fb0823 100644 --- a/System/Posix/Process/Common.hsc +++ b/System/Posix/Process/Common.hsc @@ -301,7 +301,7 @@ foreign import ccall "forkProcess" forkProcessPrim :: StablePtr (IO ()) -> IO CP -- | Variant of 'forkProcess' in the style of 'forkIOWithUnmask'. -- --- /Since: 2.7.0.0/ +-- @since 2.7.0.0 forkProcessWithUnmask :: ((forall a . IO a -> IO a) -> IO ()) -> IO ProcessID forkProcessWithUnmask action = forkProcess (action unsafeUnmask) diff --git a/System/Posix/Process/Internals.hs b/System/Posix/Process/Internals.hs index 0bd99ae..ddafa10 100644 --- a/System/Posix/Process/Internals.hs +++ b/System/Posix/Process/Internals.hs @@ -19,7 +19,7 @@ data ProcessStatus -- signal, the @Bool@ is @True@ if a core -- dump was produced -- - -- /Since: 2.7.0.0/ + -- @since 2.7.0.0 | Stopped Signal -- ^ the process was stopped by a signal deriving (Eq, Ord, Show) diff --git a/System/Posix/Signals.hsc b/System/Posix/Signals.hsc index 971973e..f26765d 100644 --- a/System/Posix/Signals.hsc +++ b/System/Posix/Signals.hsc @@ -310,13 +310,13 @@ data Handler = Default -- not yet: | Hold | Catch (IO ()) | CatchOnce (IO ()) - | CatchInfo (SignalInfo -> IO ()) -- ^ /Since: 2.7.0.0/ - | CatchInfoOnce (SignalInfo -> IO ()) -- ^ /Since: 2.7.0.0/ + | CatchInfo (SignalInfo -> IO ()) -- ^ @since 2.7.0.0 + | CatchInfoOnce (SignalInfo -> IO ()) -- ^ @since 2.7.0.0 deriving (Typeable) -- | Information about a received signal (derived from @siginfo_t@). -- --- /Since: 2.7.0.0/ +-- @since 2.7.0.0 data SignalInfo = SignalInfo { siginfoSignal :: Signal, siginfoError :: Errno, @@ -326,7 +326,7 @@ data SignalInfo = SignalInfo { -- | Information specific to a particular type of signal -- (derived from @siginfo_t@). -- --- /Since: 2.7.0.0/ +-- @since 2.7.0.0 data SignalSpecificInfo = NoSignalSpecificInfo | SigChldInfo { diff --git a/System/Posix/Unistd.hsc b/System/Posix/Unistd.hsc index 84bd472..ec02216 100644 --- a/System/Posix/Unistd.hsc +++ b/System/Posix/Unistd.hsc @@ -227,7 +227,7 @@ foreign import ccall unsafe "sysconf" -- provide @fsync(2)@ (use @#if HAVE_FSYNC@ CPP guard to -- detect availability). -- --- /Since: 2.7.1.0/ +-- @since 2.7.1.0 fileSynchronise :: Fd -> IO () #if HAVE_FSYNC fileSynchronise fd = do @@ -248,7 +248,7 @@ fileSynchronise _ = ioError (ioeSetLocation unsupportedOperation -- provide @fdatasync(2)@ (use @#if HAVE_FDATASYNC@ CPP guard to -- detect availability). -- --- /Since: 2.7.1.0/ +-- @since 2.7.1.0 fileSynchroniseDataOnly :: Fd -> IO () #if HAVE_FDATASYNC fileSynchroniseDataOnly fd = do -- cgit v1.2.3