The pkg-doc Reference Manual

Table of Contents

The pkg-doc Reference Manual

This is the pkg-doc Reference Manual, version 0.0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 17:23:51 2021 GMT+0.

1 Introduction

pkg-doc

View package documentation in a clim-treeview:

(ql:quickload :pkg-doc) (pkg-doc:pd)

; to see your own projects set this variable in pkg-doc.lisp to your lisp-projects-directory (defvar my-project-dir #P"~/common-lisp/")

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 pkg-doc

Author

<j.schatzer@tin.it>

License

BSD Simplified

Description

View package documentation in a clim-treeview

Version

0.0.1

Dependencies

• stdutils
• clim-widgets
• nsort
• manifest
• alexandria
• repl-utilities

Source

pkg-doc.asd (file)

Components

• package.lisp (file)
• pkg-doc.lisp (file)
• gui-clim.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 pkg-doc.asd

Location

pkg-doc.asd

Systems

pkg-doc (system)

3.1.2 pkg-doc/package.lisp

Parent

pkg-doc (system)

Location

package.lisp

Packages

pkg-doc

3.1.3 pkg-doc/pkg-doc.lisp

Dependency

package.lisp (file)

Parent

pkg-doc (system)

Location

pkg-doc.lisp

Exported Definitions

• current-packages (function)
• local-systems (function)
• pkg-tree (function)
• quicklisp-systems (function)
• random-load-system (function)
• random-pkg-info (function)
• random-pkg-with-nr-of-ext-symbols (function)
• random-sys-info (function)

Internal Definitions

• alfabet (function)
• asdf-description (function)
• hierarchical-category (function)
• hierarchy-by-name (function)
• insert-what (function)
• insert-what% (function)
• insert-what%% (function)
• key (function)
• key% (function)
• my-project-dir (special variable)
• pack (function)
• packages-in-system (function)
• parts (function)
• pkg-description (function)
• pkg-symbols (function)
• pkg2sys (function)
• ql-system-name (function)
• r-add-header (function)
• readme-file (macro)
• readme-text (function)
• remove-empty-bags (function)
• sorted-symbols-in-a-category (function)
• strip-html (function)
• symbol-groups (function)
• sys-info (symbol macro)
• sys2pkg (function)

3.1.4 pkg-doc/gui-clim.lisp

Dependency

pkg-doc.lisp (file)

Parent

pkg-doc (system)

Location

gui-clim.lisp

Exported Definitions

pd (function)

Internal Definitions

• *help* (special variable)
• abc (method)
• (setf abc) (method)
• cl-apropos (function)
• cl-apropos%acceptor (function)
• cl-apropos%partial (function)
• cl-apropos%unparse (function)
• clear (function)
• clear%acceptor (function)
• clear%partial (function)
• clear%unparse (function)
• color-lambda (function)
• create-menu% (function)
• create-menu-clim (function)
• create-tview (function)
• define-pkg-doc-command (macro)
• features (function)
• features%acceptor (function)
• features%partial (function)
• features%unparse (function)
• help (function)
• help%acceptor (function)
• help%partial (function)
• help%unparse (function)
• info (method)
• (setf info) (method)
• leaf-pkg (class)
• load-package (function)
• local-projects (function)
• local-projects%acceptor (function)
• local-projects%partial (function)
• local-projects%unparse (function)
• modules (function)
• modules%acceptor (function)
• modules%partial (function)
• modules%unparse (function)
• node-pkg (class)
• packages (function)
• packages%acceptor (function)
• packages%partial (function)
• packages%unparse (function)
• pkg-doc (function)
• pkg-doc (class)
• print-numbered-pkg (function)
• ql-apropos (function)
• ql-apropos%acceptor (function)
• ql-apropos%partial (function)
• ql-apropos%unparse (function)
• quicklisp (function)
• quicklisp%acceptor (function)
• quicklisp%partial (function)
• quicklisp%unparse (function)
• select-pkg (function)
• show-childreno (function)
• show-info (function)
• show-info%acceptor (function)
• show-info%partial (function)
• show-info%unparse (function)
• sys-info-clim (macro)
• toggle-alfabeta (function)
• toggle-alfabeta%acceptor (function)
• toggle-alfabeta%partial (function)
• toggle-alfabeta%unparse (function)
• tview (function)

4 Packages

Packages are listed by definition order.

4.1 pkg-doc

package and system info

Source

package.lisp (file)

Use List

• clim-lisp
• clim

Exported Definitions

• current-packages (function)
• local-systems (function)
• pd (function)
• pkg-tree (function)
• quicklisp-systems (function)
• random-load-system (function)
• random-pkg-info (function)
• random-pkg-with-nr-of-ext-symbols (function)
• random-sys-info (function)

Internal Definitions

• *help* (special variable)
• abc (generic function)
• abc (method)
• (setf abc) (method)
• (setf abc) (generic function)
• alfabet (function)
• asdf-description (function)
• cl-apropos (function)
• cl-apropos%acceptor (function)
• cl-apropos%partial (function)
• cl-apropos%unparse (function)
• clear (function)
• clear%acceptor (function)
• clear%partial (function)
• clear%unparse (function)
• color-lambda (function)
• create-menu% (function)
• create-menu-clim (function)
• create-tview (function)
• define-pkg-doc-command (macro)
• features (function)
• features%acceptor (function)
• features%partial (function)
• features%unparse (function)
• help (function)
• help%acceptor (function)
• help%partial (function)
• help%unparse (function)
• hierarchical-category (function)
• hierarchy-by-name (function)
• info (generic function)
• info (method)
• (setf info) (method)
• (setf info) (generic function)
• insert-what (function)
• insert-what% (function)
• insert-what%% (function)
• key (function)
• key% (function)
• leaf-pkg (class)
• load-package (function)
• local-projects (function)
• local-projects%acceptor (function)
• local-projects%partial (function)
• local-projects%unparse (function)
• modules (function)
• modules%acceptor (function)
• modules%partial (function)
• modules%unparse (function)
• my-project-dir (special variable)
• node-pkg (class)
• pack (function)
• packages (function)
• packages%acceptor (function)
• packages%partial (function)
• packages%unparse (function)
• packages-in-system (function)
• parts (function)
• pkg-description (function)
• pkg-doc (function)
• pkg-doc (class)
• pkg-symbols (function)
• pkg2sys (function)
• print-numbered-pkg (function)
• ql-apropos (function)
• ql-apropos%acceptor (function)
• ql-apropos%partial (function)
• ql-apropos%unparse (function)
• ql-system-name (function)
• quicklisp (function)
• quicklisp%acceptor (function)
• quicklisp%partial (function)
• quicklisp%unparse (function)
• r-add-header (function)
• readme-file (macro)
• readme-text (function)
• remove-empty-bags (function)
• select-pkg (function)
• show-childreno (function)
• show-info (function)
• show-info%acceptor (function)
• show-info%partial (function)
• show-info%unparse (function)
• sorted-symbols-in-a-category (function)
• strip-html (function)
• symbol-groups (function)
• sys-info (symbol macro)
• sys-info-clim (macro)
• sys2pkg (function)
• toggle-alfabeta (function)
• toggle-alfabeta%acceptor (function)
• toggle-alfabeta%partial (function)
• toggle-alfabeta%unparse (function)
• tview (function)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Functions

Function: current-packages ()

loaded packages with external symbols

Package

pkg-doc

Source

pkg-doc.lisp (file)

Function: local-systems ()

Package

pkg-doc

Source

pkg-doc.lisp (file)

Function: pd ()

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: pkg-tree P

exported symbols of a package in a hierachical tree-form

Package

pkg-doc

Source

pkg-doc.lisp (file)

Function: quicklisp-systems ()

Package

pkg-doc

Source

pkg-doc.lisp (file)

Function: random-load-system ()

Package

pkg-doc

Source

pkg-doc.lisp (file)

Function: random-pkg-info ()

test sys-info of current packages

Package

pkg-doc

Source

pkg-doc.lisp (file)

Function: random-pkg-with-nr-of-ext-symbols ()

Package

pkg-doc

Source

pkg-doc.lisp (file)

Function: random-sys-info ()

test sys-info of quicklisp systems

Package

pkg-doc

Source

pkg-doc.lisp (file)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *help*

Package

pkg-doc

Source

gui-clim.lisp (file)

Special Variable: my-project-dir

Package

pkg-doc

Source

pkg-doc.lisp (file)

5.2.2 Symbol macros

Symbol Macro: sys-info

Package

pkg-doc

Source

pkg-doc.lisp (file)

Expansion

(sb-int:quasiquote ((pkg-doc::s #s(sb-impl::comma :expr pkg-doc::s :kind 0)) (pkg-doc::pkg #s(sb-impl::comma :expr pkg-doc::pkg :kind 0)) (pkg-doc::nr (length (pkg-doc::pkg-symbols pkg-doc::pkg))) (pkg-doc::a1 (car (pkg-doc::asdf-description pkg-doc::pkg))) (pkg-doc::a2 (cadr (pkg-doc::asdf-description pkg-doc::pkg))) (pkg-doc::a3 (pkg-doc::readme-text pkg-doc::pkg)) (pkg-doc::nick (package-nicknames pkg-doc::pkg))))

5.2.3 Macros

Macro: define-pkg-doc-command NAME-AND-OPTIONS ARGUMENTS &rest BODY

Package

pkg-doc

Source

gui-clim.lisp (file)

Macro: readme-file SYS

Look for a system’s documentation file

Package

pkg-doc

Source

pkg-doc.lisp (file)

Macro: sys-info-clim S PKG

system description

Package

pkg-doc

Source

gui-clim.lisp (file)

5.2.4 Functions

Function: alfabet P

Package

pkg-doc

Source

pkg-doc.lisp (file)

Function: asdf-description SYS

Package

pkg-doc

Source

pkg-doc.lisp (file)

Function: cl-apropos ()

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: cl-apropos%acceptor STREAM0

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: cl-apropos%partial COMMAND-TABLE2 STREAM3 PARTIAL-COMMAND4

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: cl-apropos%unparse COMMAND9 STREAM11

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: clear ()

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: clear%acceptor STREAM0

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: clear%partial COMMAND-TABLE2 STREAM3 PARTIAL-COMMAND4

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: clear%unparse COMMAND9 STREAM11

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: color-lambda S L

color lambda list

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: create-menu% L &aux N

insert :items and :value into a tree to create a clim-menu

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: create-menu-clim L

turn a list into a sorted numbered list

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: create-tview PKG

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: features ()

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: features%acceptor STREAM0

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: features%partial COMMAND-TABLE2 STREAM3 PARTIAL-COMMAND4

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: features%unparse COMMAND9 STREAM11

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: help ()

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: help%acceptor STREAM0

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: help%partial COMMAND-TABLE2 STREAM3 PARTIAL-COMMAND4

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: help%unparse COMMAND9 STREAM11

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: hierarchical-category L

Package

pkg-doc

Source

pkg-doc.lisp (file)

Function: hierarchy-by-name L

Package

pkg-doc

Source

pkg-doc.lisp (file)

Function: insert-what L

Package

pkg-doc

Source

pkg-doc.lisp (file)

Function: insert-what% W S

Package

pkg-doc

Source

pkg-doc.lisp (file)

Function: insert-what%% L

Package

pkg-doc

Source

pkg-doc.lisp (file)

Function: key S &optional I

Package

pkg-doc

Source

pkg-doc.lisp (file)

Function: key% S I

key ~ header

Package

pkg-doc

Source

pkg-doc.lisp (file)

Function: load-package P

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: local-projects ()

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: local-projects%acceptor STREAM0

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: local-projects%partial COMMAND-TABLE2 STREAM3 PARTIAL-COMMAND4

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: local-projects%unparse COMMAND9 STREAM11

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: modules ()

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: modules%acceptor STREAM0

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: modules%partial COMMAND-TABLE2 STREAM3 PARTIAL-COMMAND4

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: modules%unparse COMMAND9 STREAM11

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: pack L &optional I V

Package

pkg-doc

Source

pkg-doc.lisp (file)

Function: packages ()

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: packages%acceptor STREAM0

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: packages%partial COMMAND-TABLE2 STREAM3 PARTIAL-COMMAND4

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: packages%unparse COMMAND9 STREAM11

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: packages-in-system S

new packages after loading a system, with dependency packages/systems

Package

pkg-doc

Source

pkg-doc.lisp (file)

Function: parts X

Package

pkg-doc

Source

pkg-doc.lisp (file)

Function: pkg-description S PKG

system description

Package

pkg-doc

Source

pkg-doc.lisp (file)

Function: pkg-doc &optional PKG

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: pkg-symbols PKG

Package

pkg-doc

Source

pkg-doc.lisp (file)

Function: pkg2sys P

Package

pkg-doc

Source

pkg-doc.lisp (file)

Function: print-numbered-pkg ITEM STRM

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: ql-apropos ()

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: ql-apropos%acceptor STREAM0

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: ql-apropos%partial COMMAND-TABLE2 STREAM3 PARTIAL-COMMAND4

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: ql-apropos%unparse COMMAND9 STREAM11

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: ql-system-name SYS

Package

pkg-doc

Source

pkg-doc.lisp (file)

Function: quicklisp ()

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: quicklisp%acceptor STREAM0

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: quicklisp%partial COMMAND-TABLE2 STREAM3 PARTIAL-COMMAND4

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: quicklisp%unparse COMMAND9 STREAM11

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: r-add-header L IND

Package

pkg-doc

Source

pkg-doc.lisp (file)

Function: readme-text P

Get text from the system’s docfile. If doc is html strip the tags

Package

pkg-doc

Source

pkg-doc.lisp (file)

Function: remove-empty-bags L

Package

pkg-doc

Source

pkg-doc.lisp (file)

Function: select-pkg SYSTEM-CATEGORY

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: show-childreno F P

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: show-info ITEM

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: show-info%acceptor STREAM0

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: show-info%partial COMMAND-TABLE2 STREAM3 PARTIAL-COMMAND4

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: show-info%unparse COMMAND10 STREAM12

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: sorted-symbols-in-a-category PKG WHAT

return a sorted list of all symbols in a category

Package

pkg-doc

Source

pkg-doc.lisp (file)

Function: strip-html S

Package

pkg-doc

Source

pkg-doc.lisp (file)

Function: symbol-groups PKG

group symbols into manifest::*categories*

Package

pkg-doc

Source

pkg-doc.lisp (file)

Function: sys2pkg P

Package

pkg-doc

Source

pkg-doc.lisp (file)

Function: toggle-alfabeta ()

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: toggle-alfabeta%acceptor STREAM0

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: toggle-alfabeta%partial COMMAND-TABLE2 STREAM3 PARTIAL-COMMAND4

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: toggle-alfabeta%unparse COMMAND9 STREAM11

Package

pkg-doc

Source

gui-clim.lisp (file)

Function: tview TREE KEY

Package

pkg-doc

Source

gui-clim.lisp (file)

5.2.5 Generic functions

Generic Function: abc OBJECT

Generic Function: (setf abc) NEW-VALUE OBJECT

Package

pkg-doc

Methods

Method: abc (PKG-DOC pkg-doc)

automatically generated reader method

Source

gui-clim.lisp (file)

Method: (setf abc) NEW-VALUE (PKG-DOC pkg-doc)

automatically generated writer method

Source

gui-clim.lisp (file)

Generic Function: info OBJECT

Generic Function: (setf info) NEW-VALUE OBJECT

Package

pkg-doc

Methods

Method: info (PKG-DOC pkg-doc)

automatically generated reader method

Source

gui-clim.lisp (file)

Method: (setf info) NEW-VALUE (PKG-DOC pkg-doc)

automatically generated writer method

Source

gui-clim.lisp (file)

5.2.6 Classes

Class: leaf-pkg ()

Package

pkg-doc

Source

gui-clim.lisp (file)

Direct superclasses

leaf (class)

Direct methods

item-name (method)

Class: node-pkg ()

Package

pkg-doc

Source

gui-clim.lisp (file)

Direct superclasses

node (class)

Direct methods

• children (method)
• get-children (method)
• item-name (method)

Class: pkg-doc ()

Package

pkg-doc

Source

gui-clim.lisp (file)

Direct superclasses

tree (class)

Direct methods

• generate-panes (method)
• abc (method)
• abc (method)
• info (method)
• info (method)

Direct slots

Slot: info

Initform

""

Readers

info (generic function)

Writers

(setf info) (generic function)

Slot: abc

Initform

(quote pkg-doc::func)

Readers

abc (generic function)

Writers

(setf abc) (generic function)

Direct Default Initargs

Initarg	Value
:name	(quote pkg-doc::pkg-doc)
:pretty-name	"pkg-doc"
:command-table	(clim:find-command-table (quote pkg-doc::pkg-doc))
:disabled-commands	(quote nil)
:menu-bar	(quote t)
:current-layout	(quote pkg-doc::double)
:layouts	(quote ((pkg-doc::double (clim:horizontally nil pkg-doc::tree-pane (clim:make-pane (quote clim-extensions:box-adjuster-gadget)) pkg-doc::info-pane))))
:resize-frame	(quote nil)
:top-level-lambda	(lambda (#:frame-arg0) (clim:default-frame-top-level #:frame-arg0))

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types