Make docs nicer

This commit is contained in:
Evan Czaplicki 2013-10-22 10:09:22 +02:00
parent f1b1bcd5fd
commit 463873b771
5 changed files with 13 additions and 14 deletions

View file

@ -6,7 +6,7 @@ module Color where
built-in names. built-in names.
# Creation # Creation
@docs rgb, rgba, hsv, hsva, grayscale, greyscale @docs rgb, rgba, hsv, hsva, greyscale, grayscale
# From Other Colors # From Other Colors
@docs complement @docs complement

View file

@ -125,7 +125,7 @@ tiled to fill the entire shape.
textured : String -> Shape -> Form textured : String -> Shape -> Form
textured src shape = fill (Texture src) shape textured src shape = fill (Texture src) shape
{-| Fill a shape with a [gradient](/docs/Color.elm#linear). -} {-| Fill a shape with a [gradient](/library/Color.elm#linear). -}
gradient : Gradient -> Shape -> Form gradient : Gradient -> Shape -> Form
gradient grad shape = fill (Grad grad) shape gradient grad shape = fill (Grad grad) shape

View file

@ -204,9 +204,8 @@ flow dir es =
DIn -> newFlow (List.maximum ws) (List.maximum hs) DIn -> newFlow (List.maximum ws) (List.maximum hs)
DOut -> newFlow (List.maximum ws) (List.maximum hs) DOut -> newFlow (List.maximum ws) (List.maximum hs)
{-| Stack elements vertically. To put `a` above `b` you would say: {-| Stack elements vertically.
To put `a` above `b` you would say: ``a `above` b``
a `above` b
-} -}
above : Element -> Element -> Element above : Element -> Element -> Element
above hi lo = above hi lo =
@ -214,9 +213,8 @@ above hi lo =
(heightOf hi + heightOf lo) (heightOf hi + heightOf lo)
(Flow DDown [hi,lo]) (Flow DDown [hi,lo])
{-| Stack elements vertically. To put `a` below `b` you would say: {-| Stack elements vertically.
To put `a` below `b` you would say: ``a `below` b``
a `below` b
-} -}
below : Element -> Element -> Element below : Element -> Element -> Element
below lo hi = below lo hi =
@ -225,6 +223,7 @@ below lo hi =
(Flow DDown [hi,lo]) (Flow DDown [hi,lo])
{-| Put elements beside each other horizontally. {-| Put elements beside each other horizontally.
To put `a` beside `b` you would say: ``a `beside` b``
-} -}
beside : Element -> Element -> Element beside : Element -> Element -> Element
beside lft rht = beside lft rht =
@ -232,8 +231,8 @@ beside lft rht =
(max (heightOf lft) (heightOf rht)) (max (heightOf lft) (heightOf rht))
(Flow right [lft,rht]) (Flow right [lft,rht])
{-| Layer elements on top of each other, starting from the bottom. {-| Layer elements on top of each other, starting from the bottom:
`(layers == flow outward)` `layers == flow outward`
-} -}
layers : [Element] -> Element layers : [Element] -> Element
layers es = layers es =

View file

@ -9,7 +9,7 @@ integration.
@docs toString, toInt, toFloat, toBool, toList @docs toString, toInt, toFloat, toBool, toList
# JavaScript from Elm # JavaScript from Elm
@docs fromString, fromInt, fromFloat, fromBool fromList @docs fromString, fromInt, fromFloat, fromBool, fromList
-} -}
{- {-
# DOM Nodes and Elements # DOM Nodes and Elements

View file

@ -15,15 +15,15 @@ the [`Time`](/docs/Signal/Time.elm) library.
# Combine # Combine
@docs constant, lift, lift2, merge, merges, combine @docs constant, lift, lift2, merge, merges, combine
# Pretty Lift
@docs (<~), (~)
# Past-Dependence # Past-Dependence
@docs foldp, count, countIf @docs foldp, count, countIf
#Filters #Filters
@docs keepIf, dropIf, keepWhen, dropWhen, dropRepeats, sampleOn @docs keepIf, dropIf, keepWhen, dropWhen, dropRepeats, sampleOn
# Pretty Lift
@docs (<~), (~)
# Do you even lift? # Do you even lift?
@docs lift3, lift4, lift5, lift6, lift7, lift8 @docs lift3, lift4, lift5, lift6, lift7, lift8