Permalink
Browse files

Started CLHS-like docs.

Signed-off-by: Stelian Ionescu <sionescu@common-lisp.net>
  • Loading branch information...
1 parent 365dad9 commit 699ad0b1364c165f9a13914c90aecaaa842b4d27 @sionescu committed Feb 24, 2008
Showing with 49 additions and 0 deletions.
  1. +13 −0 doc/iolib.clhsdoc
  2. +25 −0 doc/sockets-contents.clhsdoc
  3. +11 −0 doc/sockets-layout.clhsdoc
View
@@ -0,0 +1,13 @@
+;;;; -*- Mode: Lisp; Syntax: ANSI-Common-Lisp; Indent-tabs-mode: NIL -*-
+;;;
+;;; iolib.clhsdoc --- Main iolib documentation.
+;;;
+;;; Copyright (C) 2008, Stelian Ionescu <sionescu@common-lisp.net>
+
+(defdoc "IOLib" ()
+ (:author "Stelian Ionescu")
+ (:author-email "<sionescu@common-lisp.net>")
+ (:contents
+;;; (chapter "I/O Events" :file "ioevents")
+;;; (chapter "Streams")
+ (chapter "Sockets")))
@@ -0,0 +1,25 @@
+;;;; -*- Mode: Lisp; Syntax: ANSI-Common-Lisp; Indent-tabs-mode: NIL -*-
+;;;
+;;; sockets-contents.clhsdoc --- Sockets documentation.
+;;;
+;;; Copyright (C) 2008, Stelian Ionescu <sionescu@common-lisp.net>
+
+(define-function make-socket (&key (family :internet) (type :stream)
+ (connect :active) (ipv6 *ipv6*)
+ (external-format :default) &allow-other-keys)
+ (:args
+ (family "A socket family specifier")
+ (type "A socket type specifier")
+ (connect "A socket connect specifier")
+ (ipv6 "One of NIL, T or :IPV6")
+ (external-format "An external format specifier"))
+ (:return
+ (socket "A socket"))
+ (:description
+ "Creates a socket instance of the appropriate subclass of SOCKET.")
+ (:examples)
+ (:affected-by *ipv6*)
+ (:exceptional-situations
+ "Can signal conditions which are subtypes of SOCKET-ERROR or of POSIX-ERROR.")
+ (:see-also with-open-socket with-accept-connection)
+ (:notes))
@@ -0,0 +1,11 @@
+;;;; -*- Mode: Lisp; Syntax: ANSI-Common-Lisp; Indent-tabs-mode: NIL -*-
+;;;
+;;; sockets-layout.clhsdoc --- Sockets documentation layout.
+;;;
+;;; Copyright (C) 2008, Stelian Ionescu <sionescu@common-lisp.net>
+
+;; :navbar
+
+:dictionary
+
+;; :indexes

0 comments on commit 699ad0b

Please sign in to comment.