Update doc comments.

This commit is contained in:
Dillon Kearns 2021-05-23 16:08:55 -07:00
parent fda8d7ff75
commit 2c74cd1323
5 changed files with 11 additions and 7 deletions

File diff suppressed because one or more lines are too long

View File

@ -1,9 +1,8 @@
module DataSource.Glob exposing
( Glob, atLeastOne, extractMatches, fullFilePath, literal, map, oneOf, run, singleFile, succeed, toNonEmptyWithDefault, toPattern, toDataSource, zeroOrMore
, wildcard, recursiveWildcard, int
, capture
, capture, match
, expectUniqueFile
, match
)
{-|
@ -15,7 +14,7 @@ module DataSource.Glob exposing
@docs wildcard, recursiveWildcard, int
@docs capture, ignore
@docs capture, match
## File Matching Helpers

View File

@ -3,10 +3,9 @@ module Head exposing
, rssLink, sitemapLink, rootLanguage
, structuredData
, AttributeValue
, currentPageFullUrl, raw
, currentPageFullUrl, urlAttribute, raw
, appleTouchIcon, icon
, toJson, canonicalLink
, urlAttribute
)
{-| This module contains low-level functions for building up
@ -30,7 +29,7 @@ writing a plugin package to extend `elm-pages`.
## `AttributeValue`s
@docs AttributeValue
@docs currentPageFullUrl, fullImageUrl, fullPageUrl, raw
@docs currentPageFullUrl, urlAttribute, raw
## Icons

View File

@ -7,12 +7,15 @@ then the canonicalUrl will not be prepended when it is used in a head tag.
If you refer to a local page, like `Route.Index {} |> Route.toPath |> Pages.Url.fromPath`, or `Pages.Url.fromPath`
@docs Url, external, fromPath, toAbsoluteUrl, toString
-}
import Pages.Internal.String as String
import Path exposing (Path)
{-| -}
type Url
= Internal String
| External String
@ -41,6 +44,7 @@ toString path =
url
{-| -}
toAbsoluteUrl : String -> Url -> String
toAbsoluteUrl canonicalSiteUrl url =
case url of

View File

@ -30,6 +30,8 @@ second does not.
-}
{-| The path portion of the URL, normalized to ensure that path segments are joined with `/`s in the right places (no doubled up or missing slashes).
-}
type Path
= Path String