Minor layout tweaks in documentation

This commit is contained in:
Evan Czaplicki 2013-09-09 23:07:49 -07:00
parent 66add54195
commit c69ff2a10b
6 changed files with 49 additions and 23 deletions

View file

@ -1,4 +1,3 @@
module Color where module Color where
{-| Library for working with colors. Includes {-| Library for working with colors. Includes
@ -13,12 +12,27 @@ built-in names.
@docs complementary @docs complementary
# Gradients # Gradients
@docs linear radial @docs linear, radial
# Built-in Colors # Built-in Colors
These come from the [Tango These colors come from the [Tango
palette](http://tango.freedesktop.org/Tango_Icon_Theme_Guidelines). palette](http://tango.freedesktop.org/Tango_Icon_Theme_Guidelines)
@docs red, orange, yellow, green, blue, purple, brown, black, white, grey, gray, charcoal, lightRed, lightOrange, lightYellow, lightGreen, lightBlue, lightPurple, lightBrown, lightGrey, lightGray, lightCharcoal, darkRed, darkOrange, darkYellow, darkGreen, darkBlue, darkPurple, darkBrown, darkGrey, darkGray, darkCharcoal which provides reasonable defaults for colors.
Each color comes with a light and dark version.
The six colors ranging from `lightGrey` to `darkCharcoal` are
a compatible series of shades of grey.
### Standard
@docs red, orange, yellow, green, blue, purple, brown,
grey, gray, charcoal, black, white
### Light
@docs lightRed, lightOrange, lightYellow, lightGreen, lightBlue,
lightPurple, lightBrown, lightGrey, lightGray, lightCharcoal
### Dark
@docs darkRed, darkOrange, darkYellow, darkGreen, darkBlue,
darkPurple, darkBrown, darkGrey, darkGray, darkCharcoal
-} -}

View file

@ -8,7 +8,7 @@ module Dict (empty,singleton,insert
,toList,fromList ,toList,fromList
) where ) where
{-|A dictionary mapping unique keys to values. The keys can be any comparable {-| A dictionary mapping unique keys to values. The keys can be any comparable
type. This includes `Int`, `Float`, `Time`, `Char`, `String`, and tuples or type. This includes `Int`, `Float`, `Time`, `Char`, `String`, and tuples or
lists of comparable types. lists of comparable types.

View file

@ -1,12 +1,15 @@
{-| A library for asynchronous HTTP requests (AJAX). See the {-| A library for asynchronous HTTP requests. See the
[WebSocket](http://elm-lang.org/docs/WebSocket.elm) library if [WebSocket](http://elm-lang.org/docs/WebSocket.elm) library if
you have very strict latency requirements. you have very strict latency requirements.
# Types # Sending Requests
@docs Request, Response @docs send, sendGet
# Making requests # Creating Requests
@docs request, get, post, send, sendGet @docs get, post, request
# Responses
@docs Response
-} -}

View file

@ -6,9 +6,9 @@ module Set (empty,singleton,insert,remove
,toList,fromList ,toList,fromList
) where ) where
{-|A set of unique values. The values can be any comparable type. This includes {-| A set of unique values. The values can be any comparable type. This
`Int`, `Float`, `Time`, `Char`, `String`, and tuples or lists of comparable includes `Int`, `Float`, `Time`, `Char`, `String`, and tuples or lists
types. of comparable types.
Insert, remove, and query operations all take *O(log n)* time. Insert, remove, and query operations all take *O(log n)* time.

View file

@ -3,14 +3,17 @@ module Text where
{-| Functions for displaying text {-| Functions for displaying text
# Constructors # Creating Text
@docs toText @docs toText
# Stylizing and displaying Text # Creating Elements
@docs typeface, monospace, header, link, height, color, bold, italic, overline, underline, strikethrough, justified, centered, righted, text, plaintext @docs plainText, asText, text, centered, justified, righted
# Converting other elements to Text # Formatting
@docs asText @docs color, typeface, height, link
# Simple Formatting
@docs monospace, header, bold, italic, underline, overline, strikethrough
-} -}

View file

@ -1,10 +1,16 @@
module Time where module Time where
{-| Library for working with time. Type `Time` represents some number of {-| Library for working with time.
milliseconds.
# Type and Constructors # Units
@docs Time, millisecond, fps, fpsWhen, every, since, timestamp, delay @docs Time, millisecond, second, minute, hour,
inMilliseconds, inSeconds, inMinutes, inHours
# Tickers
@docs fps, fpsWhen, every
# Timing
@docs timestamp, delay, since
-} -}