Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions .config/dotnet-tools.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,25 @@
"isRoot": true,
"tools": {
"fantomas": {
"version": "6.3.16",
"version": "7.0.3",
"commands": [
"fantomas"
]
],
"rollForward": false
},
"fsharp-analyzers": {
"version": "0.32.1",
"commands": [
"fsharp-analyzers"
]
],
"rollForward": false
},
"dotnet-repl": {
"version": "0.1.216",
"commands": [
"dotnet-repl"
]
],
"rollForward": false
}
}
}
2 changes: 1 addition & 1 deletion global.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"sdk": {
"version": "8.0.400",
"version": "10.0.100",
"rollForward": "latestMinor"
}
}
56 changes: 28 additions & 28 deletions src/FSharp.Formatting.ApiDocs/GenerateHtml.fs
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ type HtmlRender(model: ApiDocModel, ?menuTemplateFolder: string) =
thead [] [
tr [] [
td [ Class "fsdocs-member-list-header" ] [ !!tableHeader ]
td [ Class "fsdocs-member-list-header" ] [ !! "Description"; fsdocsDetailsToggle [] ]
td [ Class "fsdocs-member-list-header" ] [ !!"Description"; fsdocsDetailsToggle [] ]
]
]
tbody [] [
Expand All @@ -131,23 +131,23 @@ type HtmlRender(model: ApiDocModel, ?menuTemplateFolder: string) =
p [] [ a [ Id m.Name ] [ a [ Href("#" + m.Name) ] [ embed m.UsageHtml ] ] ]
] [
div [ Class "member-tooltip" ] [
!! "Full Usage: "
!!"Full Usage: "
embed m.UsageHtml
br []
br []
if not m.Parameters.IsEmpty then
!! "Parameters: "
!!"Parameters: "

ul [] [
for p in m.Parameters do
span [] [
b [] [ !!p.ParameterNameText ]
!! ":"
!!":"
embed p.ParameterType
match p.ParameterDocs with
| None -> ()
| Some d ->
!! " - "
!!" - "
embed d
]

Expand All @@ -174,7 +174,7 @@ type HtmlRender(model: ApiDocModel, ?menuTemplateFolder: string) =
//!! "Signature: "
//encode(m.SignatureTooltip)
if not m.Modifiers.IsEmpty then
!! "Modifiers: "
!!"Modifiers: "
encode (m.FormatModifiers)
br []

Expand All @@ -183,7 +183,7 @@ type HtmlRender(model: ApiDocModel, ?menuTemplateFolder: string) =
match m.FormatTypeArguments with
| None -> ()
| Some v ->
!! "Type parameters: "
!!"Type parameters: "
encode (v)
]
]
Expand All @@ -207,7 +207,7 @@ type HtmlRender(model: ApiDocModel, ?menuTemplateFolder: string) =

match m.ExtendedType with
| Some(_, extendedTypeHtml) ->
p [] [ !! "Extended Type: "; embed extendedTypeHtml ]
p [] [ !!"Extended Type: "; embed extendedTypeHtml ]
| _ -> ()

if not m.Parameters.IsEmpty then
Expand All @@ -217,7 +217,7 @@ type HtmlRender(model: ApiDocModel, ?menuTemplateFolder: string) =
span [ Class "fsdocs-param-name" ] [
!!parameter.ParameterNameText
]
!! ":"
!!":"
embed parameter.ParameterType
]

Expand Down Expand Up @@ -263,12 +263,12 @@ type HtmlRender(model: ApiDocModel, ?menuTemplateFolder: string) =
]

for e in m.Comment.Notes do
h5 [ Class "fsdocs-note-header" ] [ !! "Note" ]
h5 [ Class "fsdocs-note-header" ] [ !!"Note" ]

p [ Class "fsdocs-note" ] [ embed e ]

for e in m.Comment.Examples do
h5 [ Class "fsdocs-example-header" ] [ !! "Example" ]
h5 [ Class "fsdocs-example-header" ] [ !!"Example" ]

p [
yield Class "fsdocs-example"
Expand Down Expand Up @@ -314,7 +314,7 @@ type HtmlRender(model: ApiDocModel, ?menuTemplateFolder: string) =
elif hasTypes then "Type"
else "Modules")
]
td [] [ !! "Description" ]
td [] [ !!"Description" ]
]
]
tbody [] [
Expand Down Expand Up @@ -375,7 +375,7 @@ type HtmlRender(model: ApiDocModel, ?menuTemplateFolder: string) =
h2 [] [ !!(usageName + (if entity.IsTypeDefinition then " Type" else " Module")) ]
dl [ Class "fsdocs-metadata" ] [
dt [] [
!! "Namespace: "
!!"Namespace: "
a [ Href(info.Namespace.Url(root, collectionName, qualify, model.FileExtensions.InUrl)) ] [
!!info.Namespace.Name
]
Expand All @@ -386,19 +386,19 @@ type HtmlRender(model: ApiDocModel, ?menuTemplateFolder: string) =
| None -> ()
| Some parentModule ->
dt [] [
!! "Parent Module: "
!!"Parent Module: "
a [ Href(parentModule.Url(root, collectionName, qualify, model.FileExtensions.InUrl)) ] [
!!parentModule.Name
]
]

match entity.AbbreviatedType with
| Some(_, abbreviatedTypHtml) -> dt [] [ !! "Abbreviation For: "; embed abbreviatedTypHtml ]
| Some(_, abbreviatedTypHtml) -> dt [] [ !!"Abbreviation For: "; embed abbreviatedTypHtml ]

| None -> ()

match entity.BaseType with
| Some(_, baseTypeHtml) -> dt [] [ !! "Base Type: "; embed baseTypeHtml ]
| Some(_, baseTypeHtml) -> dt [] [ !!"Base Type: "; embed baseTypeHtml ]
| None -> ()

match entity.AllInterfaces with
Expand All @@ -408,7 +408,7 @@ type HtmlRender(model: ApiDocModel, ?menuTemplateFolder: string) =
!!("All Interfaces: ")
for (i, (_, ityHtml)) in Seq.indexed l do
if i <> 0 then
!! ", "
!!", "

embed ityHtml
]
Expand Down Expand Up @@ -444,20 +444,20 @@ type HtmlRender(model: ApiDocModel, ?menuTemplateFolder: string) =
| Some r -> p [ Class "fsdocs-remarks" ] [ embed r ]
| None -> ()
for note in entity.Comment.Notes do
h5 [ Class "fsdocs-note-header" ] [ !! "Note" ]
h5 [ Class "fsdocs-note-header" ] [ !!"Note" ]

p [ Class "fsdocs-note" ] [ embed note ]

for example in entity.Comment.Examples do
h5 [ Class "fsdocs-example-header" ] [ !! "Example" ]
h5 [ Class "fsdocs-example-header" ] [ !!"Example" ]

p [ Class "fsdocs-example" ] [ embed example ]

]

if (byCategory.Length > 1) then
// If there is more than 1 category in the type, generate TOC
h3 [] [ !! "Table of contents" ]
h3 [] [ !!"Table of contents" ]

ul [] [
for (index, _, name) in byCategory do
Expand Down Expand Up @@ -528,7 +528,7 @@ type HtmlRender(model: ApiDocModel, ?menuTemplateFolder: string) =
]

if (allByCategory.Length > 1) then
h3 [] [ !! "Contents" ]
h3 [] [ !!"Contents" ]

ul [] [
for category in allByCategory do
Expand Down Expand Up @@ -576,13 +576,13 @@ type HtmlRender(model: ApiDocModel, ?menuTemplateFolder: string) =
//
// For non-FSharp.Core we only show one link "API Reference" in the nav menu
if otherDocs && model.Collection.CollectionName <> "FSharp.Core" then
li [ Class "nav-header" ] [ !! "API Reference" ]
li [ Class "nav-header" ] [ !!"API Reference" ]

li [ Class "nav-item" ] [
a [
Class "nav-link"
Href(model.IndexFileUrl(root, collectionName, qualify, model.FileExtensions.InUrl))
] [ !! "All Namespaces" ]
] [ !!"All Namespaces" ]
]
else

Expand All @@ -591,7 +591,7 @@ type HtmlRender(model: ApiDocModel, ?menuTemplateFolder: string) =
let someExist = categorise.Length > 0

if someExist then
li [ Class "nav-header" ] [ !! "Namespaces" ]
li [ Class "nav-header" ] [ !!"Namespaces" ]

for allByCategory, ns in categorise do

Expand Down Expand Up @@ -713,13 +713,13 @@ type HtmlRender(model: ApiDocModel, ?menuTemplateFolder: string) =

(let content =
div [] [
h1 [] [ !! "API Reference" ]
h2 [] [ !! "Available Namespaces:" ]
h1 [] [ !!"API Reference" ]
h2 [] [ !!"Available Namespaces:" ]
table [ Class "table outer-list fsdocs-member-list" ] [
thead [] [
tr [] [
td [ Class "fsdocs-member-list-header" ] [ !! "Namespace" ]
td [ Class "fsdocs-member-list-header" ] [ !! "Description" ]
td [ Class "fsdocs-member-list-header" ] [ !!"Namespace" ]
td [ Class "fsdocs-member-list-header" ] [ !!"Description" ]
]
]
tbody [] (tableOfNamespacesAux ())
Expand Down
Loading