package.lisp

   1 ;;; -*- lisp; show-trailing-whitespace: t; indent-tabs: nil -*-
   2
   3 ;;;; Part of this software was originally written as docstrings.lisp in
   4 ;;;; SBCL, but is now part of the parse-docstrings project.  The file
   5 ;;;; docstrings.lisp was written by Rudi Schlatte <rudi@constantly.at>,
   6 ;;;; mangled by Nikodemus Siivola, turned into a stand-alone project by
   7 ;;;; Luis Oliveira.  SBCL is in the public domain and is provided with
   8 ;;;; absolutely no warranty.
   9
  10 ;;;; parse-docstrings is:
  11 ;;;;
  12 ;;;; Copyright (c) 2008 David Lichteblau:
  13 ;;;;
  14 ;;;; Permission is hereby granted, free of charge, to any person
  15 ;;;; obtaining a copy of this software and associated documentation
  16 ;;;; files (the "Software"), to deal in the Software without
  17 ;;;; restriction, including without limitation the rights to use, copy,
  18 ;;;; modify, merge, publish, distribute, sublicense, and/or sell copies
  19 ;;;; of the Software, and to permit persons to whom the Software is
  20 ;;;; furnished to do so, subject to the following conditions:
  21 ;;;;
  22 ;;;; The above copyright notice and this permission notice shall be
  23 ;;;; included in all copies or substantial portions of the Software.
  24 ;;;;
  25 ;;;; THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  26 ;;;; EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  27 ;;;; MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  28 ;;;; NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
  29 ;;;; HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  30 ;;;; WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  31 ;;;; OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  32 ;;;; DEALINGS IN THE SOFTWARE.
  33
  34 (defpackage #:parse-docstrings
  35   (:use #:cl #:c2mop :iterate)
  36   (:export #:documentation*
  37            #:collect-documentation
  38            #:collect-symbol-documentation
  39            #:documentation<
  40            #:setf-name-p
  41            #:lambda-list)
  42
  43   (:export #:markup-element
  44            #:block-content
  45            #:inline-content
  46            #:parent-mixin
  47            #:text
  48            #:preformatted
  49            #:code-block
  50            #:inline-code
  51            #:itemization
  52            #:enumeration
  53            #:paragraph
  54            #:div
  55            #:span
  56            #:bold
  57            #:italic
  58            #:fixed-width
  59            #:underline
  60            #:definition-list
  61            #:definition-list-item
  62            #:hyperlink
  63            #:inline-cross-reference
  64            #:unknown-element
  65
  66            #:characters
  67            #:child-elements
  68            #:list-items
  69            #:definition-title
  70
  71            #:make-text
  72            #:make-preformatted
  73            #:make-fixed-width
  74            #:make-code-block
  75            #:make-inline-code
  76            #:make-itemization
  77            #:make-enumeration
  78            #:make-paragraph
  79            #:make-div
  80            #:make-span
  81            #:make-bold
  82            #:make-italic
  83            #:make-underline
  84            #:make-list-item
  85            #:make-definition-list
  86            #:make-definition-list-item
  87            #:make-hyperlink
  88            #:make-unknown-element
  89            #:make-inline-cross-reference)
  90
  91   (:export #:documentation-annotations
  92            #:cross-reference-annotation
  93            #:parameter-annotation
  94            #:summary-annotation
  95            #:implementation-note-annotation
  96
  97            #:argument-annotations
  98            #:return-value-annotations
  99            #:condition-annotations
 100            #:slot-accessor-annotations
 101            #:constructor-annotations
 102            #:see-also-annotations
 103            #:cross-reference-target
 104            #:cross-reference-doc-type
 105
 106            #:make-parameter-annotation
 107            #:make-cross-reference-annotation
 108
 109            #:sort-annotations!)
 110
 111   (:export #:missing-symbol
 112            #:missing-symbol-name
 113            #:missing-symbol-package-name
 114            #:parse-symbol
 115            #:look-up-missing-symbol)
 116
 117   (:export #:markup-to-sexp
 118            #:sexp-to-markup))
 119
 120 (defpackage #:parse-docstrings.sbcl
 121   (:use :cl)
 122   (:export #:parse-docstring))
 123
 124 (defpackage #:parse-docstrings.atsign
 125   (:use :cl)
 126   (:export #:parse-docstring))