Convert /since/ to @since syntax
authorHerbert Valerio Riedel <hvr@gnu.org>
Tue, 19 Apr 2016 17:37:41 +0000 (19:37 +0200)
committerHerbert Valerio Riedel <hvr@gnu.org>
Tue, 19 Apr 2016 17:38:13 +0000 (19:38 +0200)
System/Posix/Fcntl.hsc
System/Posix/Files.hsc
System/Posix/Files/Common.hsc
System/Posix/Process/Common.hsc
System/Posix/Process/Internals.hs
System/Posix/Signals.hsc
System/Posix/Unistd.hsc

index 2d8ef12..c78f361 100644 (file)
@@ -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
index 7c637cc..bbda084 100644 (file)
@@ -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 =
index a1a4278..cc594cc 100644 (file)
@@ -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) =
index 59212e4..7fb0823 100644 (file)
@@ -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)
 
index 0bd99ae..ddafa10 100644 (file)
@@ -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)
 
index 971973e..f26765d 100644 (file)
@@ -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 {
index 84bd472..ec02216 100644 (file)
@@ -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