documentation more consistent

This commit is contained in:
2026-08-03 16:50:36 +02:00
parent e674693a28
commit 16b3a784ad
19 changed files with 136 additions and 130 deletions
+7 -7
View File
@@ -7,7 +7,7 @@
setup/dirs
"../racket-webview-downloader.rkt"))
@title{racket-webview-downloader}
@title[#:tag "racket-webview-downloader"]{racket-webview-downloader}
@author[@author+email["Hans Dijkema" "hans@dijkewijk.nl"]]
@defmodule[racket-webview/racket-webview-downloader]
@@ -18,7 +18,7 @@ This module provides functions for checking whether the native runtime is
already installed, whether it can be resolved and downloaded, and for
downloading and unpacking it into the user's addon directory.
@section{Overview}
@section[#:tag "racket-webview-downloader-overview"]{Overview}
The module manages one specific downloadable version of the native
@tt{racket-webview-qt} package. The version is fixed in the source code through
@@ -36,7 +36,7 @@ The download URL is derived from:
The downloaded archive is installed below the user's addon directory in a
subdirectory named @tt{racket-webview-qt}.
@section{Installation Layout}
@section[#:tag "racket-webview-downloader-installation-layout"]{Installation Layout}
The installation directory is:
@@ -57,7 +57,7 @@ The OS and architecture components are derived from:
(system-type 'arch)
]
@section{Availability and Version Checks}
@section[#:tag "racket-webview-downloader-availability-and-version-checks"]{Availability and Version Checks}
@defproc[(racket-webview-qt-is-available?) boolean?]{
@@ -93,7 +93,7 @@ The returned path has the form:
]
}
@section{Downloadability Checks}
@section[#:tag "racket-webview-downloader-downloadability-checks"]{Downloadability Checks}
@defproc[(racket-webview-qt-resolves?) boolean?]{
@@ -114,7 +114,7 @@ succeeds, the port is closed immediately and the function returns
@racket[#t]. Any failure is caught and results in @racket[#f].
}
@section{Downloading}
@section[#:tag "racket-webview-downloader-downloading"]{Downloading}
@defproc[(download-racket-webview-qt) boolean?]{
@@ -138,7 +138,7 @@ If no download port can be obtained, the function raises an exception. Otherwise
on successful completion, it returns @racket[#t].
}
@section{Notes}
@section[#:tag "racket-webview-downloader-notes"]{Notes}
The module forces HTTPS downloads by temporarily setting the current HTTPS
protocol to @racket['secure] while opening the download port.