Verified Commit b0bf19c8 authored by Camil Staps's avatar Camil Staps 🚀

Remove all @gin annotations

parent 9eac5e1d
Pipeline #29275 passed with stage
in 5 minutes and 36 seconds
......@@ -48,8 +48,6 @@ usersWithRole :: !Role -> SDSLens () [User] ()
* @param Password: The password
*
* @return A single user who matches the given credentials, or nothing of none or more than one exists.
* @gin-icon key
*/
authenticateUser :: !Username !Password -> Task (Maybe User)
......@@ -57,8 +55,6 @@ authenticateUser :: !Username !Password -> Task (Maybe User)
* Wraps a task with an authentication task
*
* @param the task to wrap
*
* @gin-icon key
*/
doAuthenticated :: (Task a) -> Task a | iTask a
......@@ -71,8 +67,6 @@ doAuthenticatedWith :: !(Credentials -> Task (Maybe User)) (Task a) -> Task a |
* @param User details: The user-information which needs to be stored
*
* @return The stored user
*
* @gin-icon user_add
*/
createUser :: !UserAccount -> Task StoredUserAccount
/**
......@@ -81,8 +75,6 @@ createUser :: !UserAccount -> Task StoredUserAccount
* @param User: The user who needs to be deleted
*
* @return The deleted user
*
* @gin-icon user_delete
*/
deleteUser :: !UserId -> Task ()
/**
......
......@@ -105,8 +105,6 @@ manageWorkOfCurrentUser :: !(Maybe HtmlTag) -> Task ()
*
* @param Workflow: The workflow to add
* @return The description of the added workflow
*
* @gin False
*/
addWorkflows :: ![Workflow] -> Task [Workflow]
......
......@@ -11,8 +11,6 @@ from System.FilePath import :: FilePath
*
* @return The imported content
* @throws FileException
*
* @gin-icon page_white_csv
*/
importCSVFile :: !FilePath -> Task [[String]]
importCSVDocument :: !Document -> Task [[String]]
......@@ -27,8 +25,6 @@ importCSVDocument :: !Document -> Task [[String]]
*
* @return The imported content
* @throws FileException
*
* @gin False
*/
importCSVFileWith :: !Char !Char !Char !FilePath -> Task [[String]]
importCSVDocumentWith :: !Char !Char !Char !Document -> Task [[String]]
......@@ -40,8 +36,6 @@ importCSVDocumentWith :: !Char !Char !Char !Document -> Task [[String]]
* @param Cells: The content to export as a list of rows of lists of fields
*
* @return The exported content as a document
*
* @gin-icon page_white_csv
*/
createCSVFile :: !String ![[String]] -> Task Document
/**
......@@ -52,8 +46,6 @@ createCSVFile :: !String ![[String]] -> Task Document
*
* @return The exported content
* @throws FileException
*
* @gin-icon page_white_csv
*/
exportCSVFile :: !FilePath ![[String]] -> Task [[String]]
/**
......@@ -68,7 +60,5 @@ exportCSVFile :: !FilePath ![[String]] -> Task [[String]]
*
* @return The exported content
* @throws FileException
*
* @gin False
*/
exportCSVFileWith :: !Char !Char !Char !FilePath ![[String]] -> Task [[String]]
......@@ -36,8 +36,6 @@ derive class iTask FileException
*
* @return The imported document
* @throws FileException
*
* @gin-icon page_white
*/
importDocument :: !FilePath -> Task Document
......@@ -49,8 +47,6 @@ importDocument :: !FilePath -> Task Document
*
* @return The exported document
* @throws FileException
*
* @gin-icon page_white
*/
exportDocument :: !FilePath !Document -> Task Document
......@@ -14,8 +14,6 @@ instance toString JSONParseException
*
* @return The imported content
* @throws FileException
*
* @gin-icon page_white_json
*/
importJSONFile :: !FilePath -> Task a | iTask a
importJSONDocument :: !Document -> Task a | iTask a
......@@ -28,8 +26,6 @@ importJSONDocument :: !Document -> Task a | iTask a
*
* @return The imported content
* @throws FileException
*
* @gin False
*/
importJSONFileWith :: !(JSONNode -> Maybe a) !FilePath -> Task a | iTask a
/**
......@@ -48,8 +44,6 @@ createJSONFile :: !String a -> Task Document | iTask a
* @param Value: The content to encode as JSON using the generic JSON encoder
*
* @return The exported content
*
* @gin-icon page_white_json
*/
exportJSONFile :: !FilePath a -> Task a | iTask a
/**
......@@ -61,7 +55,5 @@ exportJSONFile :: !FilePath a -> Task a | iTask a
*
* @return The exported content
* @throws FileException
*
* @gin False
*/
exportJSONFileWith :: !(a -> JSONNode) !FilePath a -> Task a | iTask a
......@@ -35,9 +35,6 @@ instance toString CallException
* @param Run with pseudo terminal options
* @return return-code of the process
* @throws CallException
*
* @gin-title Start executable
* @gin-icon executable
*/
callProcess :: ![ViewOption ProcessInformation] !FilePath ![String] !(Maybe FilePath) (Maybe ProcessPtyOptions) -> Task ProcessInformation
......
......@@ -11,8 +11,6 @@ from iTasks.Extensions.Document import :: Document
*
* @return The imported content
* @throws FileException
*
* @gin-icon page_white_text
*/
importTextFile :: !FilePath -> Task String
......@@ -34,7 +32,5 @@ importTextDocument :: !Document -> Task String
*
* @return The exported content
* @throws FileException
*
* @gin-icon page_white_text
*/
exportTextFile :: !FilePath !String -> Task String
......@@ -98,8 +98,6 @@ workAs :: !User !(Task a) -> Task a | iTask a
* @param Task: The task that is to be delegated
*
* @return The combined task
*
* @gin False
*/
assign :: !TaskAttributes !(Task a) -> Task a | iTask a
......@@ -110,10 +108,6 @@ assign :: !TaskAttributes !(Task a) -> Task a | iTask a
* @param Task: The task that is to be delegated.
*
* @return The combined task
*
* @gin-title Assign to user
* @gin-icon user
* @gin-shape assign
*/
(@:) infix 3 :: !worker !(Task a) -> Task a | iTask a & toUserConstraint worker
......
......@@ -36,9 +36,6 @@ serveFile :: [FilePath] HTTPRequest -> Task HTTPResponse
* @param Response handler: A parse function that parses the response
*
* @return The parsed value
*
* @gin-title Call web service
* @gin-icon webservice
*/
callHTTP :: !HTTPMethod !URI !String !(HTTPResponse -> (MaybeErrorString a)) -> Task a | iTask a
......@@ -51,8 +48,5 @@ callHTTP :: !HTTPMethod !URI !String !(HTTPResponse -> (MaybeErrorString a)) ->
* @param Response handler: A parse function that parses the response
*
* @return The parsed value
*
* @gin-title Call web service
* @gin-icon webservice
*/
callRPCHTTP :: !HTTPMethod !URI ![(String,String)] !(HTTPResponse -> a) -> Task a | iTask a
......@@ -15,8 +15,6 @@ from Data.Either import :: Either
* @param Task: The task for which continuations are defined
* @param The possible continuations
* @return The continuation's result
*
* @gin False
*/
(>>*) infixl 1 :: !(Task a) ![TaskCont a (Task b)] -> Task b | iTask a & iTask b
......@@ -30,8 +28,6 @@ from Data.Either import :: Either
* @param First: The first task to be executed
* @param Second: The second task, which receives the result of the first task
* @return The combined task
*
* @gin False
*/
tbind :: !(Task a) !(a -> Task b) -> Task b | iTask a & iTask b
/**
......@@ -41,8 +37,6 @@ tbind :: !(Task a) !(a -> Task b) -> Task b | iTask a & iTask b
* @param First: The first task to be executed
* @param Second: The second task, which receives the result of the first task
* @return The combined task
*
* @gin False
*/
(>>!) infixl 1 :: !(Task a) !(a -> Task b) -> Task b | iTask a & iTask b
/**
......@@ -78,8 +72,6 @@ tbind :: !(Task a) !(a -> Task b) -> Task b | iTask a & iTask b
* @param Second: The second task to be executed
*
* @return The combined task
*
* @gin False
*/
(>>^) infixl 1 :: !(Task a) (Task b) -> Task a| iTask a & iTask b
/**
......@@ -88,8 +80,6 @@ tbind :: !(Task a) !(a -> Task b) -> Task b | iTask a & iTask b
* @param Task: The task on which the transform should be applied
* @param The transformation function to apply
* @return The transformed task
*
* @gin False
*/
(@?) infixl 1 :: !(Task a) !((TaskValue a) -> TaskValue b) -> Task b
/**
......@@ -98,8 +88,6 @@ tbind :: !(Task a) !(a -> Task b) -> Task b | iTask a & iTask b
* @param Task: The task on which the transform should be applied
* @param The transformation function to apply
* @return The transformed task
*
* @gin False
*/
(@) infixl 1 :: !(Task a) !(a -> b) -> Task b
/**
......@@ -126,9 +114,6 @@ sideStep :: !(Task a) ![TaskCont a (Task b)] -> Task a | iTask a & iTask b
* @param Task: The normal task which will possibly raise an exception of type e
* @param Handler: The exception handling task which gets the exception as parameter
* @return The combined task
*
* @gin-title Try block
* @gin-icon catch
*/
try :: !(Task a) (e -> Task a) -> Task a | iTask a & iTask, toString e
/**
......@@ -136,9 +121,6 @@ try :: !(Task a) (e -> Task a) -> Task a | iTask a & iTask, toString e
*
* @param Task: The normal task which will possibly raise an exception of any type
* @param Handler: The exception handling task
*
* @gin-title Catch all exceptions
* @gin-icon catch
*/
catchAll :: !(Task a) (String -> Task a) -> Task a | iTask a
......@@ -148,8 +130,6 @@ catchAll :: !(Task a) (String -> Task a) -> Task a | iTask a
*
* @param The task that could in theory return Nothing
* @return The result of the task
*
* @gin False
*/
justdo :: !(Task (Maybe a)) -> Task a | iTask a
......@@ -158,8 +138,6 @@ justdo :: !(Task (Maybe a)) -> Task a | iTask a
*
* @param Tasks: The list of tasks to be executed sequentially
* @return The combined task
*
* @gin-icon sequence
*/
sequence :: ![Task a] -> Task [a] | iTask a
......@@ -216,8 +194,6 @@ forever :: (Task a) -> Task a | iTask a
* @param Right: The right task
*
* @return The result of the task that is completed first
*
* @gin False
*/
(-||-) infixr 3 :: !(Task a) !(Task a) -> Task a | iTask a
......@@ -228,8 +204,6 @@ forever :: (Task a) -> Task a | iTask a
* @param Right: The right task
*
* @return The result of the task that is completed first
*
* @gin False
*/
(||-) infixr 3 :: !(Task a) !(Task b) -> Task b | iTask a & iTask b
......@@ -240,8 +214,6 @@ forever :: (Task a) -> Task a | iTask a
* @param Right: The right task
*
* @return The result of the task that is completed first
*
* @gin False
*/
(-||) infixl 3 :: !(Task a) !(Task b) -> Task a | iTask a & iTask b
......@@ -252,10 +224,6 @@ forever :: (Task a) -> Task a | iTask a
* @param Right: The right task
*
* @return The results of both tasks
*
* @gin-parallel True
* @gin-title Parallel merge (tuple)
* @gin-icon parallel-merge-tuple
*/
(-&&-) infixr 4 :: !(Task a) !(Task b) -> Task (a,b) | iTask a & iTask b
......@@ -293,10 +261,6 @@ feedBidirectionally :: !((SDSLens () (Maybe b) ()) -> Task a) !((SDSLens () (May
* @param Tasks: The list of tasks
*
* @return The first result
*
* @gin-parallel True
* @gin-title Take first completed
* @gin-icon parallel-merge-first
*/
anyTask :: ![Task a] -> Task a | iTask a
......@@ -307,10 +271,6 @@ anyTask :: ![Task a] -> Task a | iTask a
* @param Tasks: The list of tasks
*
* @return The list of results
*
* @gin-parallel True
* @gin-title Parallel merge (list)
* @gin-icon parallel-merge-list
*/
allTasks :: ![Task a] -> Task [a] | iTask a
......@@ -322,8 +282,6 @@ allTasks :: ![Task a] -> Task [a] | iTask a
* @param Right: The right task
*
* @return The result of the first completed task wrapped in an 'Either'.
*
* @gin False
*/
eitherTask :: !(Task a) !(Task b) -> Task (Either a b) | iTask a & iTask b
......
......@@ -141,7 +141,6 @@ step :: !(Task a) ((Maybe a) -> (Maybe b)) [TaskCont a (Task b)] -> Task b | TC,
* The task in the parallel set that raised the exception is replaced
* with the continuation
* @return The sum of all results
* @gin False
*/
parallel :: ![(ParallelTaskType,ParallelTask a)] [TaskCont [(Int,TaskValue a)] (ParallelTaskType,ParallelTask a)] -> Task [(Int,TaskValue a)] | iTask a
......
......@@ -16,9 +16,6 @@ from iTasks.UI.Editor import :: EditMode
* @param Value: The value to be returned
* @default ()
* @return A task that will return the value defined by the parameter
*
* @gin-icon return
* @gin-shape return
*/
treturn :: !a -> Task a | iTask a
......@@ -28,9 +25,6 @@ treturn :: !a -> Task a | iTask a
*
* @param Value: The exception value
* @return The combined task
*
* @gin-title Raise exception
* @gin-icon error
*/
throw :: !e -> Task a | iTask a & iTask, toString e
......@@ -39,8 +33,6 @@ throw :: !e -> Task a | iTask a & iTask, toString e
*
* @param World function: The function to evaluate
* @return A () task that evaluates the function
*
* @gin False
*/
appWorld :: !(*World -> *World) -> Task ()
......@@ -49,8 +41,6 @@ appWorld :: !(*World -> *World) -> Task ()
*
* @param World function: The function to evaluate
* @return A task that evaluates the function and yield a
*
* @gin False
*/
accWorld :: !(*World -> *(a,*World)) -> Task a | iTask a
......@@ -61,8 +51,6 @@ accWorld :: !(*World -> *(a,*World)) -> Task a | iTask a
* @param Error function: Error transformation function
*
* @return A task that evaluates the function
*
* @gin False
*/
accWorldError :: !(*World -> (MaybeError e a, *World)) !(e -> err) -> Task a | iTask a & TC, toString err
......@@ -73,8 +61,6 @@ accWorldError :: !(*World -> (MaybeError e a, *World)) !(e -> err) -> Task a |
* @param Error function: Error transformation function
*
* @return A task that evaluates the function
*
* @gin False
*/
accWorldOSError :: !(*World -> (MaybeOSError a, *World)) -> Task a | iTask a
......
......@@ -19,9 +19,6 @@ from Data.Maybe import :: Maybe
* @param Shared: A shared reference
* @return The value read
* @throws SharedException
*
* @gin-title Read shared
* @gin-icon shared_read
*/
get :: !(sds () a w) -> Task a | iTask a & Readable sds & TC w
......@@ -32,9 +29,6 @@ get :: !(sds () a w) -> Task a | iTask a & Readable sds & TC w
* @param Shared: A shared reference
* @return The value written
* @throws SharedException
*
* @gin-title Write shared
* @gin-icon shared_update
*/
set :: !a !(sds () r a) -> Task a | iTask a & TC r & Writeable sds
......@@ -45,9 +39,6 @@ set :: !a !(sds () r a) -> Task a | iTask a & TC r & Writeable sds
* @param Update function: A function modifying the shared value
* @return The value written
* @throws SharedException
*
* @gin-title Update shared
* @gin-icon shared_update
*/
upd :: !(r -> w) !(sds () r w) -> Task w | iTask r & iTask w & RWShared sds
......@@ -57,9 +48,6 @@ upd :: !(r -> w) !(sds () r w) -> Task w | iTask r & iTask w & RWShared sds
* @param Shared: A shared reference
* @return The value read
* @throws SharedException
*
* @gin-title Read shared
* @gin-icon shared_read
*/
watch :: !(sds () r w) -> Task r | iTask r & TC w & Readable, Registrable sds
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment