From b91b26f586211b8359fd488f6095732ca32be975 Mon Sep 17 00:00:00 2001 From: hellerve Date: Tue, 19 Jan 2021 13:03:03 +0100 Subject: [PATCH] better docs --- docs/ZLib.html | 31 ++++++------------------------- gendocs.carp | 15 ++++++--------- zlib.carp | 17 +++++++++-------- 3 files changed, 21 insertions(+), 42 deletions(-) diff --git a/docs/ZLib.html b/docs/ZLib.html index 32c55ea..7b4f578 100644 --- a/docs/ZLib.html +++ b/docs/ZLib.html @@ -4,13 +4,13 @@ - +

- (λ [&String, ZLevel] (Result ZBytes String)) + (Fn [(Ref String a), ZLib.ZLevel] (Result ZBytes String)) 

                     (deflate-with s level)
@@ -155,7 +136,7 @@ well, and an Error returning an error message otherwise.

                     defn

- (λ [ZBytes] (Result String String)) + (Fn [ZBytes] (Result String String)) 

                     (inflate s)
diff --git a/gendocs.carp b/gendocs.carp
index d8d0c45..2e6a61f 100644
--- a/gendocs.carp
+++ b/gendocs.carp
@@ -1,13 +1,10 @@
 (load "zlib.carp")
 
-(defndynamic gendocs []
-       (do
-         (Project.config "title" "zlib")
-         (Project.config "docs-directory" "./docs/")
-         (Project.config "docs-logo" "")
-         (Project.config "docs-styling" "style.css")
-         (Project.config "docs-generate-index" false)
-         (save-docs ZLib)))
+(Project.config "title" "zlib")
+(Project.config "docs-directory" "./docs/")
+(Project.config "docs-logo" "")
+(Project.config "docs-styling" "../style.css")
+(Project.config "docs-generate-index" false)
+(save-docs ZLib)
 
-(gendocs)
 (quit)
diff --git a/zlib.carp b/zlib.carp
index d968515..d87608a 100644
--- a/zlib.carp
+++ b/zlib.carp
@@ -41,14 +41,13 @@ default.")
 ; i tried doing this in carp, but it’s a bit of a pain to wrap the API
 ; idiomatically, so for now you’ll only get regular inflation and deflation
 (defmodule ZLib
-  (doc ZBytes "is an opaque bytes type with an associated length.")
   (register-type ZBytes [
     len Int
     bytes String
   ])
+  (private ZBytes)
+  (hidden ZBytes)
 
-  (private ZRes)
-  (hidden ZRes)
   (register-type ZRes)
   (defmodule ZRes
     (register ok? (Fn [&ZRes] Bool) "ZRes_is_ok")
@@ -56,12 +55,9 @@ default.")
     (register str (Fn [ZRes] String) "ZRes_str")
     (register err (Fn [ZRes] String) "ZRes_err")
   )
+  (private ZRes)
+  (hidden ZRes)
 
-  (doc ZLevel "is a type used in conjunction with
-[`deflate-with`](#deflate-with). It controls the compression level.
-
-The constructors are `NoCompression`, `BestSpeed`, `BestCompression`, and
-`DefaultCompression`, which is, well, the default.")
   (deftype ZLevel
     (NoCompression [])
     (BestSpeed [])
@@ -76,6 +72,11 @@ The constructors are `NoCompression`, `BestSpeed`, `BestCompression`, and
         (BestSpeed) 1
         (BestCompression) 9
         (DefaultCompression) -1)))
+  (doc ZLevel "is a type used in conjunction with
+[`deflate-with`](#deflate-with). It controls the compression level.
+
+The constructors are `NoCompression`, `BestSpeed`, `BestCompression`, and
+`DefaultCompression`, which is, well, the default.")
 
   (private inflate-)
   (hidden inflate-)