(html (head (title "sph-lib (sph documentation)") (link (@ (rel "stylesheet") (type "text/css") (href "/css/sph.css"))) (meta (@ (name "viewport") (content "width=device-width,initial-scale=1"))) #f) (body () (div (@ (class top)) (nav (a (@ (href "/")) "start") ", " (a (@ (href "/feed.xml")) "feed")) "") (div (@ (class "middle")) (div (@ (class mtime) (title "last modification time of the current page")) "2023-04-05") (section (h1 "(sph documentation)") (div (p "extract and display documentation (bindings, arguments and docstrings) from modules") (p "part of " (a (@ (href "../../sph-lib.html")) "sph-lib")) (#f (section (@ (class "library-name")) (h1 "module name") (p "(sph documentation)")) (section (@ (class "library-exports")) (h1 "exported bindings") (div (div (@ (class "doc-bindings")) (div (@ (id "doc-b-" "default-format-arguments") (class "doc-b")) (div (span (@ (class "type")) "procedure") ": " (span (@ (class "name")) "default-format-arguments") " " (span (@ (class "first-sig")) "arguments type ->")) "" "") (div (@ (id "doc-b-" "display-module-information-short") (class "doc-b")) (div (span (@ (class "type")) "procedure") ": " (span (@ (class "name")) "display-module-information-short") " " (span (@ (class "first-sig")) "a [markdown?] ->")) "" "") (div (@ (id "doc-b-" "doc-bindings") (class "doc-b")) (div (span (@ (class "type")) "procedure") ": " (span (@ (class "name")) "doc-bindings") " " (span (@ (class "first-sig")) "libraries [pair] ->")) (div (@ (class "rest-sig")) (div "(list ...) -> ((symbol:name . list:library-name) ...)")) (div (@ (class "description")) (("get a list of all bindings and the library name they belong to for all specified library names")))) (div (@ (id "doc-b-" "docstring-split-signature") (class "doc-b")) (div (span (@ (class "type")) "procedure") ": " (span (@ (class "name")) "docstring-split-signature") " " (span (@ (class "first-sig")) "a line-prefix c ->")) "" (div (@ (class "description")) (("string string procedure:{string:type-signatures string:rest-of-docstring} -> any" (br) "if a string starts with a type-signature, split string at the end of it")))) (div (@ (id "doc-b-" "format-module-documentation") (class "doc-b")) (div (span (@ (class "type")) "procedure") ": " (span (@ (class "name")) "format-module-documentation") " " (span (@ (class "first-sig")) "module-name [format-config] ->")) (div (@ (class "rest-sig")) (div "(symbol ...) [list] ->")) (div (@ (class "description")) (("return a string for the documentation found in a module (binding names, arguments and docstrings)." (br) "for just retrieving module documentation as scheme data consider (sph module binding-info)." (br) "example:" (br) "  (format-module-documentation (quote (rnrs sorting)))")))) (div (@ (id "doc-b-" "lines->docstring") (class "doc-b")) (div (span (@ (class "type")) "procedure") ": " (span (@ (class "name")) "lines->docstring") " " (span (@ (class "first-sig")) "a indent-string ->")) (div (@ (class "rest-sig")) (div "list (string ...) -> string")) "") (div (@ (id "doc-b-" "module-description") (class "doc-b")) (div (span (@ (class "type")) "procedure") ": " (span (@ (class "name")) "module-description") " " (span (@ (class "first-sig")) "name ->")) (div (@ (class "rest-sig")) (div "(symbol ...) -> false/string")) (div (@ (class "description")) (("get the module description from an exported variable with a specific name:" (br) "(a b c) -> a-b-c-description")))) (div (@ (id "doc-b-" "module-find-one-information") (class "doc-b")) (div (span (@ (class "type")) "procedure") ": " (span (@ (class "name")) "module-find-one-information") " " (span (@ (class "first-sig")) "search-paths module-find-one-arguments ... ->")) "" "") (div (@ (id "doc-b-" "module-find-one-information-sorted") (class "doc-b")) (div (span (@ (class "type")) "procedure") ": " (span (@ (class "name")) "module-find-one-information-sorted") " " (span (@ (class "first-sig")) "search-paths module-find-arguments ... ->")) "" "") (div (@ (id "doc-b-" "output-format-indent") (class "doc-b")) (div (span (@ (class "type")) "variable") ": " (span (@ (class "name")) "output-format-indent")) "" "") (div (@ (id "doc-b-" "output-format-list") (class "doc-b")) (div (span (@ (class "type")) "variable") ": " (span (@ (class "name")) "output-format-list")) "" "") (div (@ (id "doc-b-" "output-format-markdown") (class "doc-b")) (div (span (@ (class "type")) "variable") ": " (span (@ (class "name")) "output-format-markdown")) "" "") (div (@ (id "doc-b-" "output-format-signature") (class "doc-b")) (div (span (@ (class "type")) "variable") ": " (span (@ (class "name")) "output-format-signature")) "" "") (div (@ (id "doc-b-" "sort-module-information") (class "doc-b")) (div (span (@ (class "type")) "procedure") ": " (span (@ (class "name")) "sort-module-information") " " (span (@ (class "first-sig")) "a ->")) "" "") (div (@ (id "doc-b-" "sph-documentation-description") (class "doc-b")) (div (span (@ (class "type")) "variable") ": " (span (@ (class "name")) "sph-documentation-description")) "" "")))))))) ()))