Update documentation.

Author: robinheghan

src/Compiler/Backend.gren

@@ -23,9 +23,9 @@ module Compiler.Backend exposing
 
 @docs version
 
-@docs UnsupportedPlatform, downloadUrl, download, cachePath, isCached
+@docs UnsupportedPlatform, downloadUrl, download
 
-@docs Command, InitFlags, ReplFlags, MakeFlags, MakeOutput, DocsFlags, DocsOutput, DiffArgs, Platform, encodeCommand, run
+@docs Command, ReplFlags, MakeFlags, MakeOutput, DocsFlags, DocsOutput, PackageValidateFlags, PackageDiffFlags, SourceFile, encodeCommand, run
 
 -}
 
@@ -141,6 +141,7 @@ type alias ReplFlags =
     }
 
 
+{-|-}
 type alias SourceFile =
     { path : Path
     , data : String

src/Compiler/Dependencies.gren

@@ -5,26 +5,38 @@ module Compiler.Dependencies exposing
     )
 
 
+{-| The algorithm for calculating the required dependencies of a project.
+
+@docs SimplifiedOutline, Solution, solve
+-}
+
 import Compiler.Outline as Outline exposing (Outline)
 import Compiler.PackageName as PackageName exposing (PackageName)
 import Dict exposing (Dict)
 import SemanticVersion exposing (SemanticVersion)
 import SemanticVersionRange exposing (SemanticVersionRange)
 
 
+{-| A simlified outline only contains the information that is required by the algorithm.
+-}
 type alias SimplifiedOutline =
     { name : PackageName
     , version : SemanticVersionRange
     , dependencies : Dict String SemanticVersionRange
     }
 
 
+{-| Return value of [solve](#solve). Let's you know if you've got all the required dependencies,
+or if you're missing something.
+-}
 type Solution
     = Complete
     | Missing { name : PackageName, version : SemanticVersionRange }
     | Conflict { name : PackageName, version1 : SemanticVersionRange, version2 : SemanticVersionRange }
 
 
+{-| Calculate the required dependencies of a project.
+-}
 solve : Array { name : PackageName, version : SemanticVersionRange } -> Dict String SimplifiedOutline -> Solution
 solve rootRequirements loadedOutlines =
     solveHelp rootRequirements Dict.empty loadedOutlines

src/Compiler/License.gren

@@ -8,31 +8,46 @@ module Compiler.License exposing
     )
 
 
+{-| A module for working with OSI approved licenses.
+
+@docs License, bsd3, toString, toJson, jsonDecoder, findMostSimilar
+-}
+
 import Dict exposing (Dict)
 import Json.Decode as Decode exposing (Decoder)
 import Json.Encode as Encode
 import String.EditDistance as EditDistance
 
 
+{-| An OSI approved license.
+-}
 type License
     = License String
 
 
+{-| The BSD 3 Clause license.
+-}
 bsd3 : License
 bsd3 =
     License "BSD-3-Clause"
 
 
+{-| `String` representation for a [License](#License).
+-}
 toString : License -> String
 toString (License value) =
     value
 
 
+{-| JSON Encoder for [License](#License).
+-}
 toJson : License -> Encode.Value
 toJson license =
     Encode.string (toString license)
 
 
+{-| JSON Decoder for [License](#License).
+-}
 jsonDecoder : Decoder License
 jsonDecoder =
     Decode.string
@@ -48,6 +63,9 @@ decodeHelper givenCode =
         Decode.fail ("Invalid license name: " ++ givenCode)
 
 
+{-| Find the three most similar licenses to the given `String`. Useful if you have a
+mistyped license string and wish to suggest the correct typing.
+-}
 findMostSimilar : String -> Array String
 findMostSimilar givenCode =
     EditDistance.findMostSimilar
@@ -58,9 +76,9 @@ findMostSimilar givenCode =
         givenCode
 
 
-{-|
--- OSI approved licenses in SPDX format.
--- <https://spdx.org/licenses/>
+{-| OSI approved licenses in SPDX format.
+
+Read more at <https://spdx.org/licenses/>.
 -}
 osiApprovedSpdxLicenses : Dict String String
 osiApprovedSpdxLicenses =

src/Compiler/ModuleName.gren

@@ -7,14 +7,31 @@ module Compiler.ModuleName exposing
     )
 
 
+{-| A module for working with Gren module names.
+
+@docs ModuleName
+
+## Constructors
+
+@docs fromString, jsonDecoder
+
+## Conversions
+
+@docs toString, toJson
+-}
+
 import Json.Decode as Decode exposing (Decoder)
 import Json.Encode as Encode
 
 
+{-|-}
 type ModuleName
     = ModuleName String
 
 
+{-| Construct a [ModuleName](#ModuleName) from a `String`. Will return `Nothing`
+if the `String` doesn't represent a valid [ModuleName](#ModuleName).
+-}
 fromString : String -> Maybe ModuleName
 fromString str =
     let
@@ -36,6 +53,8 @@ fromString str =
         Nothing
 
 
+{-| JSON Decoder for [ModuleName](#ModuleName).
+-}
 jsonDecoder : Decoder ModuleName
 jsonDecoder =
     Decode.string
@@ -50,11 +69,15 @@ jsonDecoder =
             )
 
 
+{-| `String` representation for [ModuleName](#ModuleName).
+-}
 toString : ModuleName -> String
 toString (ModuleName name) =
     name
 
 
+{-| JSON Encoder for [ModuleName](#ModuleName).
+-}
 toJson : ModuleName -> Encode.Value
 toJson moduleName =
     Encode.string (toString moduleName)

src/Compiler/Outline.gren

@@ -14,6 +14,15 @@ module Compiler.Outline exposing
     )
 
 
+{-| Module for working with `gren.json` files.
+
+@docs Outline, AppOutline, PkgOutline, VersionConstraint, Exposed, defaultSummary, findSourceFiles
+
+## JSON
+
+@docs jsonDecoder, pkgJsonDecoder, toJson
+-}
+
 import Bytes
 import SemanticVersion exposing (SemanticVersion)
 import SemanticVersionRange exposing (SemanticVersionRange)
@@ -29,11 +38,13 @@ import Dict exposing (Dict)
 import Task exposing (Task)
 
 
+{-|-}
 type Outline
     = App AppOutline
     | Pkg PkgOutline
 
 
+{-|-}
 type alias AppOutline =
     { platform : Platform
     , sourceDirectories : Array Path
@@ -45,6 +56,7 @@ type alias AppOutline =
     }
 
 
+{-|-}
 type alias PkgOutline =
     { platform : Platform
     , name : PackageName
@@ -57,23 +69,29 @@ type alias PkgOutline =
     }
 
 
+{-| Exposed modules in [PkgOutline](#PkgOutline).
+-}
 type Exposed
     = ExposedArray (Array ModuleName)
     | ExposedDict (Dict String (Array ModuleName))
 
 
+{-| A dependency version constraint. Either a `SemanticVersion`, `SemanticVersionRange` or a `Path` for a local dependency.
+-}
 type VersionConstraint a
     = Version a
     | LocalPath Path
 
 
+{-| The default summary created by `gren init`.
+-}
 defaultSummary : String
 defaultSummary =
     "helpful summary of your project, less than 80 characters"
 
 
--- TODO: Ignore hidden directories
--- More info: https://github.com/gren-lang/compiler/pull/287
+{-| Find the source files of a given project.
+-}
 findSourceFiles : FileSystem.Permission -> Outline -> Path -> Task FileSystem.Error (Array { path : Path, moduleName : String, source : String })
 findSourceFiles fsPerm outline outlinePath =
     let
@@ -138,6 +156,8 @@ readSourceFile fsPerm { absolute, relative } =
             )
 
 
+{-| JSON Decoder for [Outline](#Outline).
+-}
 jsonDecoder : Decoder Outline
 jsonDecoder =
     Decode.field "type" Decode.string    
@@ -151,6 +171,8 @@ jsonDecoder =
             )
 
 
+{-| JSON Decoder for [PkgOutline](#PkgOutline).
+-}
 pkgJsonDecoder : Decoder PkgOutline
 pkgJsonDecoder =
     jsonDecoder
@@ -301,6 +323,8 @@ pkgDependenciesEncoder deps =
     Encode.dict identity (constraintEncoder SemanticVersionRange.toJson) deps
 
 
+{-| JSON Encoder for [Outline](#Outline).
+-}
 toJson : Outline -> Encode.Value
 toJson outline =
     when outline is

src/Compiler/PackageName.gren

@@ -20,7 +20,19 @@ module Compiler.PackageName exposing
 
 {-| Functions for working with package identifiers.
 
-@docs Package, example, author, name, fromString, cliParser, jsonDecoder, toString, toJson
+@docs PackageName, example
+
+## Constructors
+
+@docs fromString, cliParser, jsonDecoder
+
+## Queries
+
+@docs author, name
+
+## Conversions
+
+@docs toString, toJson
 
 ## Common package names
 
@@ -130,6 +142,8 @@ cliParser =
     }
 
 
+{-| A JSON decoder for [PackageName](#PackageName)
+-}
 jsonDecoder : Decoder PackageName
 jsonDecoder =
     Decode.string