working on the documentation

Author: SuperFola

Exceptions.ark

@@ -1,6 +1,45 @@
-(import "Functional.ark")
+###
+# @meta Exceptions
+# @brief throw takes a value as its argument and return it to be used by try
+# ---
+# (let error (throw "cannot divide by zero"))
+# ---
+# @param _x the value to return
+# @author https://github.com/SuperFola
+###
+(let throw (fun (_x)
+    (fun (_injl _injr &_x) (_injl _x))
+))
 
-(let throw left)
-(let return right)
+###
+# @meta Exceptions
+# @brief returns takes a value as its argument and return it to be used by try
+# ---
+# (let value (return (/ 1 x)))
+# ---
+# @param _x the value to return
+# @author https://github.com/SuperFola
+###
+(let return (fun (_y)
+    (fun (_injl _injr &_y) (_injr _y))
+))
+
+###
+# @meta Exceptions
+# @brief takes a value either returned by throw or return and apply a given on it if it's an error or not
+# ---
+# (let invert (fun (x)
+#     (if (= x 0)
+#         (throw "cannot divide by zero")
+#         (return (/ 1 x)))))
+# (try (invert 0)
+#     (fun (inverted) (print inverted))
+#     (fun (err) (print err)))
+# ---
+# @param _either the value to test
+# @param _continue the success handler
+# @param _handle the error handler
+# @author https://github.com/SuperFola
+###
 (let try (fun (_either _continue _handle)
     (_either _handle _continue)))

Functional.ark

@@ -1,14 +1,58 @@
-# @author: https://github.com/rstefanic
+###
+# @meta Functional
+# @brief compose function calls
+# ---
+# (let foo (fun (a) (* a a)))
+# (let bar (fun (b) (+ b b)))
+# (let composed (compose foo bar))
+# (print (composed 12))  # return value is (12 + 12) * (12 + 12)
+# ---
+# @param _f the first function
+# @param _g the second function
+# @author https://github.com/rstefanic
+###
 (let compose (fun (_f _g)
     (fun (_y &_f &_g) (_f (_g _y)))))
 
+###
+# @meta Functional
+# @brief take a value as its argument and return a function taking 2 arguments which will call the first function on the value
+# ---
+# (let val (left 12))
+# (val (fun (x) (print x " i am called")) (fun (x) (print x " i am NOT called")))
+# ---
+# @param _x the value
+# @author https://github.com/SuperFola
+###
 (let left (fun (_x)
     (fun (_injl _injr &_x) (_injl _x))
 ))
+
+###
+# @meta Functional
+# @brief take a value as its argument and return a function taking 2 arguments which will call the second function on the value
+# ---
+# (let val (right 12))
+# (val (fun (x) (print x " i am NOT called")) (fun (x) (print x " i am called")))
+# ---
+# @param _y the value
+# @author https://github.com/SuperFola
+###
 (let right (fun (_y)
     (fun (_injl _injr &_y) (_injr _y))
 ))
 
-# @author: https://github.com/rstefanic
+###
+# @meta Functional
+# @brief flip arguments of a function
+# @details returns a function taking 1 argument: the second argument of the function to flip
+# ---
+# (let foo (fun (a b) (- a b)))
+# ((flip foo 14) 12) # will call (foo 12 14) instead of (foo 14 12)
+# ---
+# @param _f the function
+# @param _a the first argument
+# @author https://github.com/rstefanic
+###
 (let flip (fun (_f _a)
     (fun (_b &_f &_a) (_f _b _a))))

List.ark

@@ -1,18 +1,18 @@
-# (([List]index)
-# !List
-# \list:forEach Iterate over a given list and run a given function on every element.
-# \list:forEach The original list is left unmodified. Example:
-# `
+###
+# @meta List
+# @brief Iterate over a given list and run a given function on every element.
+# @details The original list is left unmodified. Example:
+# ---
 # (import "List.ark")
 # (let collection [1 2 5 12])
 # (let new (list:forEach collection (fun (element) {
 #     (print element)
 # })))
-# `
-# @_L the list to iterate over
-# @_func the function to call on each element
-# author: https://github.com/SuperFola
-# )
+# ---
+# @param _L the list to iterate over
+# @param _func the function to call on each element
+# @author https://github.com/SuperFola
+###
 (let list:forEach (fun (_L _func) {
     (mut _index 0)
     (while (< _index (len _L)) {
@@ -22,18 +22,18 @@
     })
 }))
 
-# (([List]index)
-# !List
-# \list:product Iterate over a given list and multiply all the elements with the others.
-# \list:product The original list is left unmodified. Example:
-# `
+###
+# @meta List
+# @brief Iterate over a given list and multiply all the elements with the others.
+# @details The original list is left unmodified. Example:
+# ---
 # (import "List.ark")
 # (let collection [1 2 5 12])
 # (let p (list:product collection))  # => 120
-# `
-# @_L the list to iterate over
-# author: https://github.com/FrenchMasterSword
-# )
+# ---
+# @param _L the list to iterate over
+# @author https://github.com/FrenchMasterSword
+###
 (let list:product (fun (_L) {
     (mut _index 0)
     (mut _output 1)
@@ -44,18 +44,18 @@
     _output
 }))
 
-# (([List]index)
-# !List
-# \list:sum Iterate over a given list and sum all the elements.
-# \list:sum The original list is left unmodified. Example:
-# `
+###
+# @meta List
+# @brief Iterate over a given list and sum all the elements.
+# @details The original list is left unmodified. Example:
+# ---
 # (import "List.ark")
 # (let collection [1 2 5 12])
 # (let p (list:sum collection))  # => 20
-# `
-# @_L the list to iterate over
-# author: https://github.com/FrenchMasterSword
-# )
+# ---
+# @param _L the list to iterate over
+# @author https://github.com/FrenchMasterSword
+###
 (let list:sum (fun (_L) {
     (mut _index 0)
     (mut _output 0)
@@ -66,7 +66,15 @@
     _output
 }))
 
-# @author: https://github.com/rstefanic
+###
+# @meta List
+# @brief
+# @details
+# ---
+# ---
+# @param _L the list to work on
+# @author https://github.com/rstefanic
+###
 (let list:drop (fun (_L _n) {
     (mut _index _n)
     (mut _output [])
@@ -77,7 +85,15 @@
     _output
 }))
 
-# @author: https://github.com/rstefanic
+###
+# @meta List
+# @brief
+# @details
+# ---
+# ---
+# @param _L the list to work on
+# @author https://github.com/rstefanic
+###
 (let list:dropWhile (fun (_L _f) {
     (mut _index 0)
     (mut _output [])
@@ -93,7 +109,15 @@
     _output
 }))
 
-# @author: https://github.com/rstefanic
+###
+# @meta List
+# @brief
+# @details
+# ---
+# ---
+# @param _L the list to work on
+# @author https://github.com/rstefanic
+###
 (let list:filter (fun (_L _f) {
     (mut _index 0)
     (mut _output [])
@@ -105,7 +129,15 @@
     _output
 }))
 
-# @author: https://github.com/rstefanic
+###
+# @meta List
+# @brief
+# @details
+# ---
+# ---
+# @param _L the list to work on
+# @author https://github.com/rstefanic
+###
 (let list:map (fun (_L _f) {
     (mut _index 0)
     (mut _output [])
@@ -116,7 +148,15 @@
     _output
 }))
 
-# @author: https://github.com/FrenchMasterSword
+###
+# @meta List
+# @brief
+# @details
+# ---
+# ---
+# @param _L the list to work on
+# @author https://github.com/FrenchMasterSword
+###
 (let list:reduce (fun (_L _f) {
     (mut _index 1)
     (mut _output (@ _L 0))
@@ -127,7 +167,15 @@
     _output
 }))
 
-# @author: https://github.com/rstefanic
+###
+# @meta List
+# @brief
+# @details
+# ---
+# ---
+# @param _L the list to work on
+# @author https://github.com/rstefanic
+###
 (let list:take (fun (_L _n) {
     (mut _index 0)
     (mut _output [])
@@ -138,7 +186,15 @@
     _output
 }))
 
-# @author: https://github.com/rstefanic
+###
+# @meta List
+# @brief
+# @details
+# ---
+# ---
+# @param _L the list to work on
+# @author https://github.com/rstefanic
+###
 (let list:takeWhile (fun (_L _f) {
     (mut _index 0)
     (mut _output [])
@@ -155,7 +211,15 @@
     _output
 }))
 
-# @author: https://github.com/FrenchMasterSword
+###
+# @meta List
+# @brief
+# @details
+# ---
+# ---
+# @param _L the list to work on
+# @author https://github.com/FrenchMasterSword
+###
 (let list:unzip (fun (_L) {
     (let _m (len _L))
     (mut _list1 [])
@@ -172,7 +236,15 @@
 
 (import "Math.ark")  # needed for (math:min a b)
 
-# @author: https://github.com/FrenchMasterSword
+###
+# @meta List
+# @brief
+# @details
+# ---
+# ---
+# @param _L the list to work on
+# @author https://github.com/FrenchMasterSword
+###
 (let list:zip (fun (_a _b) {
     (let _m (math:min (len _a) (len _b)))
     (mut _c [])