From 9d5a90b53f1ed7f63aca2859775222da9bdd597e Mon Sep 17 00:00:00 2001 From: Justin Ethier Date: Fri, 30 Sep 2016 02:02:55 -0400 Subject: [PATCH] WIP --- docs/API.md | 243 ++++++++++++++++++++++------------ scripts/generate-doc-index.sh | 1 + 2 files changed, 158 insertions(+), 86 deletions(-) diff --git a/docs/API.md b/docs/API.md index ec744078..b21e14f8 100644 --- a/docs/API.md +++ b/docs/API.md @@ -55,176 +55,247 @@ These libraries are used by the Cyclone compiler itself, and are subject to chan # Index -- [`Cyc-add-exception-handler`](api/scheme/base.md#Cyc-add-exception-handler) -- [`Cyc-obj=?`](api/scheme/base.md#Cyc-obj=?) -- [`Cyc-remove-exception-handler`](api/scheme/base.md#Cyc-remove-exception-handler) -- [`Cyc-version`](api/scheme/base.md#Cyc-version) -- [`abs`](api/scheme/base.md#abs) -- [`acos`](api/scheme/inexact.md#acos) -- [`and`](api/scheme/base.md#and) -- [`any`](api/scheme/base.md#any) -- [`append`](api/scheme/base.md#append) -- [`asin`](api/scheme/inexact.md#asin) -- [`atan`](api/scheme/inexact.md#atan) -- [`begin`](api/scheme/base.md#begin) -- [`boolean=?`](api/scheme/base.md#boolean=?) -- [`bytevector-copy!`](api/scheme/base.md#bytevector-copy!) -- [`bytevector-copy`](api/scheme/base.md#bytevector-copy) +[`abs`](api/scheme/base.md#abs) +[`acos`](api/scheme/inexact.md#acos) +[`and`](api/scheme/base.md#and) +[`angle`](api/scheme/complex.md#angle) +[`any`](api/scheme/base.md#any) +[`append`](api/scheme/base.md#append) +[`asin`](api/scheme/inexact.md#asin) +[`assoc`](api/scheme/base.md#assoc) +[`assq`](api/scheme/base.md#assq) +[`assv`](api/scheme/base.md#assv) +[`atan`](api/scheme/inexact.md#atan) + +[`begin`](api/scheme/base.md#begin) +[`boolean=?`](api/scheme/base.md#boolean) +[`bytevector-copy`](api/scheme/base.md#bytevector-copy) +[`bytevector-copy!`](api/scheme/base.md#bytevector-copy-1) + +- [`caaaar`](api/scheme/cxr.md#caaaar) +- [`caaadr`](api/scheme/cxr.md#caaadr) +- [`caaar`](api/scheme/cxr.md#caaar) +- [`caadar`](api/scheme/cxr.md#caadar) +- [`caaddr`](api/scheme/cxr.md#caaddr) +- [`caadr`](api/scheme/cxr.md#caadr) +- [`cadaar`](api/scheme/cxr.md#cadaar) +- [`cadadr`](api/scheme/cxr.md#cadadr) +- [`cadar`](api/scheme/cxr.md#cadar) +- [`caddar`](api/scheme/cxr.md#caddar) +- [`cadddr`](api/scheme/cxr.md#cadddr) +- [`caddr`](api/scheme/cxr.md#caddr) +- [`call/cc`](api/scheme/base.md#callcc) - [`call-with-current-continuation`](api/scheme/base.md#call-with-current-continuation) +- [`call-with-input-file`](api/scheme/file.md#call-with-input-file) +- [`call-with-output-file`](api/scheme/file.md#call-with-output-file) - [`call-with-port`](api/scheme/base.md#call-with-port) - [`call-with-values`](api/scheme/base.md#call-with-values) -- [`call/cc`](api/scheme/base.md#call/cc) -- [`case-lambda`](api/scheme/case-lambda.md#case-lambda) - [`case`](api/scheme/base.md#case) +- [`case-lambda`](api/scheme/case-lambda.md#case-lambda) +- [`cdaaar`](api/scheme/cxr.md#cdaaar) +- [`cdaadr`](api/scheme/cxr.md#cdaadr) +- [`cdaar`](api/scheme/cxr.md#cdaar) +- [`cdadar`](api/scheme/cxr.md#cdadar) +- [`cdaddr`](api/scheme/cxr.md#cdaddr) +- [`cdadr`](api/scheme/cxr.md#cdadr) +- [`cddaar`](api/scheme/cxr.md#cddaar) +- [`cddadr`](api/scheme/cxr.md#cddadr) +- [`cddar`](api/scheme/cxr.md#cddar) +- [`cdddar`](api/scheme/cxr.md#cdddar) +- [`cddddr`](api/scheme/cxr.md#cddddr) +- [`cdddr`](api/scheme/cxr.md#cdddr) - [`ceiling`](api/scheme/base.md#ceiling) -- [`char<=?`](api/scheme/base.md#char<=?) -- [`char=?`](api/scheme/base.md#char>=?) -- [`char>?`](api/scheme/base.md#char>?) +- [`char-alphabetic?`](api/scheme/char.md#char-alphabetic) +- [`char<=?`](api/scheme/base.md#char) +- [`char=?`](api/scheme/base.md#char-3) +- [`char>?`](api/scheme/base.md#char-4) +- [`char-ci<=?`](api/scheme/char.md#char-ci) +- [`char-ci=?`](api/scheme/char.md#char-ci-3) +- [`char-ci>?`](api/scheme/char.md#char-ci-4) +- [`char-downcase`](api/scheme/char.md#char-downcase) +- [`char-foldcase`](api/scheme/char.md#char-foldcase) +- [`char-lower-case?`](api/scheme/char.md#char-lower-case) +- [`char-numeric?`](api/scheme/char.md#char-numeric) +- [`char-upcase`](api/scheme/char.md#char-upcase) +- [`char-upper-case?`](api/scheme/char.md#char-upper-case) +- [`char-whitespace?`](api/scheme/char.md#char-whitespace) - [`command-line`](api/scheme/process-context.md#command-line) -- [`complex?`](api/scheme/base.md#complex?) -- [`cond-expand`](api/scheme/base.md#cond-expand) +- [`complex?`](api/scheme/base.md#complex) - [`cond`](api/scheme/base.md#cond) -- [`cons-source`](api/scheme/base.md#cons-source) +- [`cond-expand`](api/scheme/base.md#cond-expand) - [`cos`](api/scheme/inexact.md#cos) +- [`create-environment`](api/scheme/eval.md#create-environment) - [`current-error-port`](api/scheme/base.md#current-error-port) - [`current-input-port`](api/scheme/base.md#current-input-port) - [`current-jiffy`](api/scheme/time.md#current-jiffy) - [`current-output-port`](api/scheme/base.md#current-output-port) - [`current-second`](api/scheme/time.md#current-second) - [`define-record-type`](api/scheme/base.md#define-record-type) -- [`delay-force`](api/scheme/lazy.md#delay-force) -- [`delay`](api/scheme/lazy.md#delay) +- [`delay`](api/scheme/lazy.md#delay) +- [`delay-force`](api/scheme/lazy.md#delay-force) - [`denominator`](api/scheme/base.md#denominator) +- [`digit-value`](api/scheme/char.md#digit-value) - [`display`](api/scheme/write.md#display) - [`do`](api/scheme/base.md#do) - [`dynamic-wind`](api/scheme/base.md#dynamic-wind) - [`emergency-exit`](api/scheme/process-context.md#emergency-exit) - [`eof-object`](api/scheme/base.md#eof-object) - [`error`](api/scheme/base.md#error) -- [`even?`](api/scheme/base.md#even?) +- [`eval`](api/scheme/eval.md#eval) +- [`even?`](api/scheme/base.md#even) - [`every`](api/scheme/base.md#every) -- [`exact-integer?`](api/scheme/base.md#exact-integer?) -- [`exact?`](api/scheme/base.md#exact?) - [`exact`](api/scheme/base.md#exact) +- [`exact?`](api/scheme/base.md#exact) +- [`exact-integer?`](api/scheme/base.md#exact-integer) - [`exp`](api/scheme/inexact.md#exp) - [`expt`](api/scheme/base.md#expt) - [`features`](api/scheme/base.md#features) -- [`floor-quotient `](api/scheme/base.md#floor-quotient ) -- [`floor-remainder `](api/scheme/base.md#floor-remainder ) -- [`floor-remainder`](api/scheme/base.md#floor-remainder) -- [`floor/ `](api/scheme/base.md#floor/ ) +- [`finite?`](api/scheme/inexact.md#finite) - [`floor`](api/scheme/base.md#floor) +- [`floor/`](api/scheme/base.md#floor-1) +- [`floor-quotient`](api/scheme/base.md#floor-quotient) +- [`floor-remainder`](api/scheme/base.md#floor-remainder ) +- [`floor-remainder`](api/scheme/base.md#floor-remainder) - [`flush-output-port`](api/scheme/base.md#flush-output-port) - [`foldl`](api/scheme/base.md#foldl) - [`foldr`](api/scheme/base.md#foldr) +- [`force`](api/scheme/lazy.md#force) - [`for-each`](api/scheme/base.md#for-each) -- [`force`](api/scheme/lazy.md#force) - [`gcd`](api/scheme/base.md#gcd) - [`get-environment-variable`](api/scheme/process-context.md#get-environment-variable) - [`get-environment-variables`](api/scheme/process-context.md#get-environment-variables) -- [`guard-aux`](api/scheme/base.md#guard-aux) +- [`get-output-bytevector`](api/scheme/base.md#get-output-bytevector) +- [`get-output-string`](api/scheme/base.md#get-output-string) - [`guard`](api/scheme/base.md#guard) -- [`inexact?`](api/scheme/base.md#inexact?) +- [`imag-part`](api/scheme/complex.md#imag-part) - [`inexact`](api/scheme/base.md#inexact) -- [`input-port-open?`](api/scheme/base.md#input-port-open?) -- [`input-port?`](api/scheme/base.md#input-port?) +- [`inexact?`](api/scheme/base.md#inexact-1) +- [`infinite?`](api/scheme/inexact.md#infinite) +- [`input-port?`](api/scheme/base.md#input-port) +- [`input-port-open?`](api/scheme/base.md#input-port-open) - [`jiffies-per-second`](api/scheme/time.md#jiffies-per-second) - [`lcm`](api/scheme/base.md#lcm) -- [`let*`](api/scheme/base.md#let*) - [`let`](api/scheme/base.md#let) -- [`letrec*`](api/scheme/base.md#letrec*) +- [`let*`](api/scheme/base.md#let-1) - [`letrec`](api/scheme/base.md#letrec) +- [`letrec*`](api/scheme/base.md#letrec-1) +- [`let*-values`](api/scheme/base.md#let-values) +- [`let-values`](api/scheme/base.md#let-values-1) +- [`list`](api/scheme/base.md#list) +- [`list?`](api/scheme/base.md#list-1) - [`list-copy`](api/scheme/base.md#list-copy) - [`list-ref`](api/scheme/base.md#list-ref) -- [`list-set!`](api/scheme/base.md#list-set!) +- [`list-set!`](api/scheme/base.md#list-set) - [`list-tail`](api/scheme/base.md#list-tail) -- [`list?`](api/scheme/base.md#list?) -- [`list`](api/scheme/base.md#list) - [`load`](api/scheme/load.md#load) - [`log`](api/scheme/inexact.md#log) +- [`magnitude`](api/scheme/complex.md#magnitude) - [`make-constructor`](api/scheme/base.md#make-constructor) - [`make-getter`](api/scheme/base.md#make-getter) - [`make-list`](api/scheme/base.md#make-list) - [`make-parameter`](api/scheme/base.md#make-parameter) -- [`make-promise`](api/scheme/lazy.md#make-promise) +- [`make-polar`](api/scheme/complex.md#make-polar) +- [`make-promise`](api/scheme/lazy.md#make-promise) +- [`make-rectangular`](api/scheme/complex.md#make-rectangular) - [`make-setter`](api/scheme/base.md#make-setter) - [`make-string`](api/scheme/base.md#make-string) - [`make-type-predicate`](api/scheme/base.md#make-type-predicate) - [`map`](api/scheme/base.md#map) - [`max`](api/scheme/base.md#max) +- [`member`](api/scheme/base.md#member) +- [`memq`](api/scheme/base.md#memq) +- [`memv`](api/scheme/base.md#memv) - [`min`](api/scheme/base.md#min) - [`modulo`](api/scheme/base.md#modulo) -- [`negative?`](api/scheme/base.md#negative?) +- [`nan?`](api/scheme/inexact.md#nan) +- [`negative?`](api/scheme/base.md#negative) - [`newline`](api/scheme/base.md#newline) - [`not`](api/scheme/base.md#not) - [`numerator`](api/scheme/base.md#numerator) -- [`odd?`](api/scheme/base.md#odd?) +- [`odd?`](api/scheme/base.md#odd) +- [`open-input-bytevector`](api/scheme/base.md#open-input-bytevector) +- [`open-input-string`](api/scheme/base.md#open-input-string) +- [`open-output-bytevector`](api/scheme/base.md#open-output-bytevector) +- [`open-output-string`](api/scheme/base.md#open-output-string) - [`or`](api/scheme/base.md#or) -- [`output-port-open?`](api/scheme/base.md#output-port-open?) -- [`output-port?`](api/scheme/base.md#output-port?) -- [`positive?`](api/scheme/base.md#positive?) -- [`promise?`](api/scheme/lazy.md#promise?) +- [`output-port?`](api/scheme/base.md#output-port) +- [`output-port-open?`](api/scheme/base.md#output-port-open) +- [`parameterize`](api/scheme/base.md#parameterize) +- [`positive?`](api/scheme/base.md#positive) +- [`promise?`](api/scheme/lazy.md#promise) - [`quasiquote`](api/scheme/base.md#quasiquote) - [`quotient`](api/scheme/base.md#quotient) -- [`raise-continuable`](api/scheme/base.md#raise-continuable) - [`raise`](api/scheme/base.md#raise) -- [`rational?`](api/scheme/base.md#rational?) +- [`raise-continuable`](api/scheme/base.md#raise-continuable) +- [`rational?`](api/scheme/base.md#rational) - [`read-all`](api/scheme/read.md#read-all) +- [`read`](api/scheme/read.md#read) - [`read-line`](api/scheme/base.md#read-line) - [`read-string`](api/scheme/base.md#read-string) -- [`read`](api/scheme/read.md#read) +- [`real-part`](api/scheme/complex.md#real-part) - [`receive`](api/scheme/base.md#receive) -- [`record?`](api/scheme/base.md#record?) -- [`register-simple-type`](api/scheme/base.md#register-simple-type) +- [`record?`](api/scheme/base.md#record) - [`remainder`](api/scheme/base.md#remainder) - [`reverse`](api/scheme/base.md#reverse) - [`round`](api/scheme/base.md#round) +- [`setup-environment`](api/scheme/eval.md#setup-environment) - [`sin`](api/scheme/inexact.md#sin) -- [`slot-set!`](api/scheme/base.md#slot-set!) +- [`slot-set!`](api/scheme/base.md#slot-set) - [`sqrt`](api/scheme/inexact.md#sqrt) - [`square`](api/scheme/base.md#square) -- [`string->list`](api/scheme/base.md#string->list) -- [`string->utf8`](api/scheme/base.md#string->utf8) -- [`string->vector`](api/scheme/base.md#string->vector) -- [`string-copy!`](api/scheme/base.md#string-copy!) -- [`string-copy`](api/scheme/base.md#string-copy) -- [`string-fill!`](api/scheme/base.md#string-fill!) -- [`string-for-each`](api/scheme/base.md#string-for-each) -- [`string-map`](api/scheme/base.md#string-map) -- [`string<=?`](api/scheme/base.md#string<=?) -- [`string=?`](api/scheme/base.md#string>=?) -- [`string>?`](api/scheme/base.md#string>?) - [`string`](api/scheme/base.md#string) -- [`symbol=?`](api/scheme/base.md#symbol=?) +- [`string<=?`](api/scheme/base.md#string-1) +- [`string=?`](api/scheme/base.md#string-4) +- [`string>?`](api/scheme/base.md#string-5) +- [`string-ci<=?`](api/scheme/char.md#string-ci) +- [`string-ci=?`](api/scheme/char.md#string-ci-3) +- [`string-ci>?`](api/scheme/char.md#string-ci-4) +- [`string-copy`](api/scheme/base.md#string-copy) +- [`string-copy!`](api/scheme/base.md#string-copy-1) +- [`string-downcase`](api/scheme/char.md#string-downcase) +- [`string-fill!`](api/scheme/base.md#string-fill) +- [`string-foldcase`](api/scheme/char.md#string-foldcase) +- [`string-for-each`](api/scheme/base.md#string-for-each) +- [`string->list`](api/scheme/base.md#string-list) +- [`string-map`](api/scheme/base.md#string-map) +- [`string-upcase`](api/scheme/char.md#string-upcase) +- [`string->utf8`](api/scheme/base.md#string-utf8) +- [`string->vector`](api/scheme/base.md#string-vector) +- [`symbol=?`](api/scheme/base.md#symbol) - [`syntax-error`](api/scheme/base.md#syntax-error) -- [`syntax-rules`](api/scheme/base.md#syntax-rules) - [`tan`](api/scheme/inexact.md#tan) -- [`truncate-quotient `](api/scheme/base.md#truncate-quotient ) -- [`truncate-remainder `](api/scheme/base.md#truncate-remainder ) -- [`truncate/ `](api/scheme/base.md#truncate/ ) - [`truncate`](api/scheme/base.md#truncate) +- [`truncate/`](api/scheme/base.md#truncate-1) +- [`truncate-quotient`](api/scheme/base.md#truncate-quotient) +- [`truncate-remainder`](api/scheme/base.md#truncate-remainder) - [`type-slot-offset`](api/scheme/base.md#type-slot-offset) - [`unless`](api/scheme/base.md#unless) -- [`utf8->string`](api/scheme/base.md#utf8->string) +- [`utf8->string`](api/scheme/base.md#utf8-string) - [`values`](api/scheme/base.md#values) -- [`vector->list`](api/scheme/base.md#vector->list) -- [`vector->string`](api/scheme/base.md#vector->string) -- [`vector-append`](api/scheme/base.md#vector-append) -- [`vector-copy!`](api/scheme/base.md#vector-copy!) -- [`vector-copy`](api/scheme/base.md#vector-copy) -- [`vector-fill!`](api/scheme/base.md#vector-fill!) -- [`vector-for-each`](api/scheme/base.md#vector-for-each) -- [`vector-map`](api/scheme/base.md#vector-map) - [`vector`](api/scheme/base.md#vector) +- [`vector-append`](api/scheme/base.md#vector-append) +- [`vector-copy`](api/scheme/base.md#vector-copy) +- [`vector-copy!`](api/scheme/base.md#vector-copy-1) +- [`vector-fill!`](api/scheme/base.md#vector-fill) +- [`vector-for-each`](api/scheme/base.md#vector-for-each) +- [`vector->list`](api/scheme/base.md#vector-list) +- [`vector-map`](api/scheme/base.md#vector-map) +- [`vector->string`](api/scheme/base.md#vector-string) - [`when`](api/scheme/base.md#when) - [`with-exception-handler`](api/scheme/base.md#with-exception-handler) +- [`with-input-from-file`](api/scheme/file.md#with-input-from-file) +- [`with-output-to-file`](api/scheme/file.md#with-output-to-file) +- [`write`](api/scheme/write.md#write) - [`write-char`](api/scheme/base.md#write-char) - [`write-shared`](api/scheme/write.md#write-shared) - [`write-simple`](api/scheme/write.md#write-simple) - [`write-string`](api/scheme/base.md#write-string) -- [`write`](api/scheme/write.md#write) -- [`zero?`](api/scheme/base.md#zero?) +- [`zero?`](api/scheme/base.md#zero) diff --git a/scripts/generate-doc-index.sh b/scripts/generate-doc-index.sh index 7dca05f0..3669ab21 100755 --- a/scripts/generate-doc-index.sh +++ b/scripts/generate-doc-index.sh @@ -3,6 +3,7 @@ API=api-index.txt TMP=/tmp/api-index.txt cyclone scripts/convert-doc-index.scm +#grep -r "^- \[" docs/api/primitives.md | ./scripts/convert-doc-index > $TMP grep -r "^- \[" docs/api/scheme/* | ./scripts/convert-doc-index > $TMP grep -r "^- \[" docs/api/srfi/* | ./scripts/convert-doc-index >> $TMP sort $TMP > $API