The pkg-doc Reference Manual

This is the pkg-doc Reference Manual, version 0.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 06:32:09 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 pkg-doc

View package documentation in a clim-treeview

Author

<>

License

BSD Simplified

Version

0.0.1

Dependencies
  • stdutils (system).
  • clim-widgets (system).
  • nsort (system).
  • manifest (system).
  • alexandria (system).
  • repl-utilities (system).
Source

pkg-doc.asd.

Child Components

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/pkg-doc.asd

Source

pkg-doc.asd.

Parent Component

pkg-doc (system).

ASDF Systems

pkg-doc.


3.1.2 pkg-doc/package.lisp

Source

pkg-doc.asd.

Parent Component

pkg-doc (system).

Packages

pkg-doc.


3.1.3 pkg-doc/pkg-doc.lisp

Dependency

package.lisp (file).

Source

pkg-doc.asd.

Parent Component

pkg-doc (system).

Public Interface
Internals

3.1.4 pkg-doc/gui-clim.lisp

Dependency

pkg-doc.lisp (file).

Source

pkg-doc.asd.

Parent Component

pkg-doc (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 pkg-doc

package and system info

Source

package.lisp.

Use List
  • clim.
  • clim-lisp.
Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Ordinary functions

Function: current-packages ()

loaded packages with external symbols

Package

pkg-doc.

Source

pkg-doc.lisp.

Function: local-systems ()
Package

pkg-doc.

Source

pkg-doc.lisp.

Function: pd ()
Package

pkg-doc.

Source

gui-clim.lisp.

Function: pkg-tree (p)

exported symbols of a package in a hierachical tree-form

Package

pkg-doc.

Source

pkg-doc.lisp.

Function: quicklisp-systems ()
Package

pkg-doc.

Source

pkg-doc.lisp.

Function: random-load-system ()
Package

pkg-doc.

Source

pkg-doc.lisp.

Function: random-pkg-info ()

test sys-info of current packages

Package

pkg-doc.

Source

pkg-doc.lisp.

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

pkg-doc.

Source

pkg-doc.lisp.

Function: random-sys-info ()

test sys-info of quicklisp systems

Package

pkg-doc.

Source

pkg-doc.lisp.


5.1.2 Standalone methods

Method: children :before ((n node-pkg))

create children-instances

Package

cw-treeview.

Source

gui-clim.lisp.

Method: item-name ((n node-pkg))
Package

cw-treeview.

Source

gui-clim.lisp.

Method: item-name ((n leaf-pkg))
Package

cw-treeview.

Source

gui-clim.lisp.

Method: update-instance-for-redefined-class :after ((instance pkg-doc) as ds pl &rest initargs)
Source

gui-clim.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *help*
Package

pkg-doc.

Source

gui-clim.lisp.

Special Variable: my-project-dir
Package

pkg-doc.

Source

pkg-doc.lisp.


5.2.2 Symbol macros

Symbol Macro: sys-info
Package

pkg-doc.

Source

pkg-doc.lisp.


5.2.3 Macros

Macro: define-pkg-doc-command (name-and-options arguments &rest body)
Package

pkg-doc.

Source

gui-clim.lisp.

Macro: readme-file (sys)

Look for a system’s documentation file

Package

pkg-doc.

Source

pkg-doc.lisp.

Macro: sys-info-clim (s pkg)

system description

Package

pkg-doc.

Source

gui-clim.lisp.


5.2.4 Ordinary functions

Function: alfabet (p)
Package

pkg-doc.

Source

pkg-doc.lisp.

Function: asdf-description (sys)
Package

pkg-doc.

Source

pkg-doc.lisp.

Function: cl-apropos ()
Package

pkg-doc.

Source

gui-clim.lisp.

Function: cl-apropos%parser (arg del str)
Package

pkg-doc.

Source

gui-clim.lisp.

Function: clear ()
Package

pkg-doc.

Source

gui-clim.lisp.

Function: clear%parser (arg del str)
Package

pkg-doc.

Source

gui-clim.lisp.

Function: color-lambda (s l)

color lambda list

Package

pkg-doc.

Source

gui-clim.lisp.

Function: create-menu% (l)

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

Package

pkg-doc.

Source

gui-clim.lisp.

Function: create-menu-clim (l)

turn a list into a sorted numbered list

Package

pkg-doc.

Source

gui-clim.lisp.

Function: create-tview (pkg)
Package

pkg-doc.

Source

gui-clim.lisp.

Function: features ()
Package

pkg-doc.

Source

gui-clim.lisp.

Function: features%parser (arg del str)
Package

pkg-doc.

Source

gui-clim.lisp.

Function: help ()
Package

pkg-doc.

Source

gui-clim.lisp.

Function: help%parser (arg del str)
Package

pkg-doc.

Source

gui-clim.lisp.

Function: hierarchical-category (l)
Package

pkg-doc.

Source

pkg-doc.lisp.

Function: hierarchy-by-name (l)
Package

pkg-doc.

Source

pkg-doc.lisp.

Function: insert-what (l)
Package

pkg-doc.

Source

pkg-doc.lisp.

Function: insert-what% (w s)
Package

pkg-doc.

Source

pkg-doc.lisp.

Function: insert-what%% (l)
Package

pkg-doc.

Source

pkg-doc.lisp.

Function: key (s &optional i)
Package

pkg-doc.

Source

pkg-doc.lisp.

Function: key% (s i)

key ~ header

Package

pkg-doc.

Source

pkg-doc.lisp.

Function: load-package (p)
Package

pkg-doc.

Source

gui-clim.lisp.

Function: local-projects ()
Package

pkg-doc.

Source

gui-clim.lisp.

Function: local-projects%parser (arg del str)
Package

pkg-doc.

Source

gui-clim.lisp.

Function: modules ()
Package

pkg-doc.

Source

gui-clim.lisp.

Function: modules%parser (arg del str)
Package

pkg-doc.

Source

gui-clim.lisp.

Function: pack (l &optional i v)
Package

pkg-doc.

Source

pkg-doc.lisp.

Function: packages ()
Package

pkg-doc.

Source

gui-clim.lisp.

Function: packages%parser (arg del str)
Package

pkg-doc.

Source

gui-clim.lisp.

Function: packages-in-system (s)

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

Package

pkg-doc.

Source

pkg-doc.lisp.

Function: parts (x)
Package

pkg-doc.

Source

pkg-doc.lisp.

Function: pkg-description (s pkg)

system description

Package

pkg-doc.

Source

pkg-doc.lisp.

Function: pkg-doc (&optional pkg)
Package

pkg-doc.

Source

gui-clim.lisp.

Function: pkg-symbols (pkg)
Package

pkg-doc.

Source

pkg-doc.lisp.

Function: pkg2sys (p)
Package

pkg-doc.

Source

pkg-doc.lisp.

Function: print-numbered-pkg (item strm)
Package

pkg-doc.

Source

gui-clim.lisp.

Function: ql-apropos ()
Package

pkg-doc.

Source

gui-clim.lisp.

Function: ql-apropos%parser (arg del str)
Package

pkg-doc.

Source

gui-clim.lisp.

Function: ql-system-name (sys)
Package

pkg-doc.

Source

pkg-doc.lisp.

Function: quicklisp ()
Package

pkg-doc.

Source

gui-clim.lisp.

Function: quicklisp%parser (arg del str)
Package

pkg-doc.

Source

gui-clim.lisp.

Function: r-add-header (l ind)
Package

pkg-doc.

Source

pkg-doc.lisp.

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.

Function: remove-empty-bags (l)
Package

pkg-doc.

Source

pkg-doc.lisp.

Function: select-pkg (system-category)
Package

pkg-doc.

Source

gui-clim.lisp.

Function: show-childreno (f p)
Package

pkg-doc.

Source

gui-clim.lisp.

Function: show-info (item)
Package

pkg-doc.

Source

gui-clim.lisp.

Function: show-info%parser (argument-parser0 delimiter-parser1 stream2)
Package

pkg-doc.

Source

gui-clim.lisp.

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.

Function: strip-html (s)
Package

pkg-doc.

Source

pkg-doc.lisp.

Function: symbol-groups (pkg)

group symbols into manifest::*categories*

Package

pkg-doc.

Source

pkg-doc.lisp.

Function: sys2pkg (p)
Package

pkg-doc.

Source

pkg-doc.lisp.

Function: toggle-alfabeta ()
Package

pkg-doc.

Source

gui-clim.lisp.

Function: toggle-alfabeta%parser (arg del str)
Package

pkg-doc.

Source

gui-clim.lisp.

Function: tview (tree key)
Package

pkg-doc.

Source

gui-clim.lisp.


5.2.5 Generic functions

Generic Reader: abc (object)
Package

pkg-doc.

Methods
Reader Method: abc ((pkg-doc pkg-doc))

automatically generated reader method

Source

gui-clim.lisp.

Target Slot

abc.

Generic Writer: (setf abc) (object)
Package

pkg-doc.

Methods
Writer Method: (setf abc) ((pkg-doc pkg-doc))

automatically generated writer method

Source

gui-clim.lisp.

Target Slot

abc.

Generic Reader: info (object)
Package

pkg-doc.

Methods
Reader Method: info ((pkg-doc pkg-doc))

automatically generated reader method

Source

gui-clim.lisp.

Target Slot

info.

Generic Writer: (setf info) (object)
Package

pkg-doc.

Methods
Writer Method: (setf info) ((pkg-doc pkg-doc))

automatically generated writer method

Source

gui-clim.lisp.

Target Slot

info.


5.2.6 Standalone methods

Method: get-children ((n node-pkg))
Package

cw-treeview.

Source

gui-clim.lisp.

Method: reinitialize-panes-and-layouts ((frame pkg-doc))
Package

clim-internals.

Source

gui-clim.lisp.


5.2.7 Classes

Class: leaf-pkg
Package

pkg-doc.

Source

gui-clim.lisp.

Direct superclasses

leaf.

Direct methods

item-name.

Class: node-pkg
Package

pkg-doc.

Source

gui-clim.lisp.

Direct superclasses

node.

Direct methods
Class: pkg-doc
Package

pkg-doc.

Source

gui-clim.lisp.

Direct superclasses

tree.

Direct methods
Direct Default Initargs
InitargValue
:name(quote pkg-doc)
:pretty-namepkg-doc
:command-table(find-command-table (quote pkg-doc))
:disabled-commands(quote nil)
:menu-bar(quote t)
:pointer-documentation(quote nil)
:current-layout(quote double)
:layouts(quote ((double (horizontally nil tree-pane (make-pane (quote box-adjuster-gadget)) info-pane))))
:resize-frame(quote nil)
:top-level-lambda(lambda (frame-arg0) (default-frame-top-level frame-arg0))
:panes-constructor(lambda (fm frame) (or (frame-panes-for-layout frame) (setf (frame-panes-for-layout frame) (with-look-and-feel-realization (fm frame) (list (cons (quote tree-pane) (make-clim-application-pane name (quote tree-pane) display-function (quote display-tree) incremental-redisplay t end-of-line-action allow end-of-page-action allow)) (cons (quote info-pane) (make-clim-application-pane name (quote info-pane) display-function (quote show-childreno) incremental-redisplay t end-of-page-action allow)))))))
:layout-constructor(lambda (fm frame) (disown-frame-panes fm frame) (let ((named-panes (frame-panes-for-layout frame))) (let ((tree-pane (assoc-value named-panes (quote tree-pane) test (function eq))) (info-pane (assoc-value named-panes (quote info-pane) test (function eq)))) (setf (frame-panes frame) (ecase (frame-current-layout frame) (double (horizontally nil tree-pane (make-pane (quote box-adjuster-gadget)) info-pane)))))) (adopt-frame-panes fm frame (frame-current-layout frame)) (update-frame-pane-lists frame))
Direct slots
Slot: info
Initform

""

Readers

info.

Writers

(setf info).

Slot: abc
Initform

(quote pkg-doc::func)

Readers

abc.

Writers

(setf abc).


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
A   C   D   F   G   H   I   K   L   M   P   Q   R   S   T   U  
Index Entry  Section

(
(setf abc): Private generic functions
(setf abc): Private generic functions
(setf info): Private generic functions
(setf info): Private generic functions

A
abc: Private generic functions
abc: Private generic functions
alfabet: Private ordinary functions
asdf-description: Private ordinary functions

C
children: Public standalone methods
cl-apropos: Private ordinary functions
cl-apropos%parser: Private ordinary functions
clear: Private ordinary functions
clear%parser: Private ordinary functions
color-lambda: Private ordinary functions
create-menu%: Private ordinary functions
create-menu-clim: Private ordinary functions
create-tview: Private ordinary functions
current-packages: Public ordinary functions

D
define-pkg-doc-command: Private macros

F
features: Private ordinary functions
features%parser: Private ordinary functions
Function, alfabet: Private ordinary functions
Function, asdf-description: Private ordinary functions
Function, cl-apropos: Private ordinary functions
Function, cl-apropos%parser: Private ordinary functions
Function, clear: Private ordinary functions
Function, clear%parser: Private ordinary functions
Function, color-lambda: Private ordinary functions
Function, create-menu%: Private ordinary functions
Function, create-menu-clim: Private ordinary functions
Function, create-tview: Private ordinary functions
Function, current-packages: Public ordinary functions
Function, features: Private ordinary functions
Function, features%parser: Private ordinary functions
Function, help: Private ordinary functions
Function, help%parser: Private ordinary functions
Function, hierarchical-category: Private ordinary functions
Function, hierarchy-by-name: Private ordinary functions
Function, insert-what: Private ordinary functions
Function, insert-what%: Private ordinary functions
Function, insert-what%%: Private ordinary functions
Function, key: Private ordinary functions
Function, key%: Private ordinary functions
Function, load-package: Private ordinary functions
Function, local-projects: Private ordinary functions
Function, local-projects%parser: Private ordinary functions
Function, local-systems: Public ordinary functions
Function, modules: Private ordinary functions
Function, modules%parser: Private ordinary functions
Function, pack: Private ordinary functions
Function, packages: Private ordinary functions
Function, packages%parser: Private ordinary functions
Function, packages-in-system: Private ordinary functions
Function, parts: Private ordinary functions
Function, pd: Public ordinary functions
Function, pkg-description: Private ordinary functions
Function, pkg-doc: Private ordinary functions
Function, pkg-symbols: Private ordinary functions
Function, pkg-tree: Public ordinary functions
Function, pkg2sys: Private ordinary functions
Function, print-numbered-pkg: Private ordinary functions
Function, ql-apropos: Private ordinary functions
Function, ql-apropos%parser: Private ordinary functions
Function, ql-system-name: Private ordinary functions
Function, quicklisp: Private ordinary functions
Function, quicklisp%parser: Private ordinary functions
Function, quicklisp-systems: Public ordinary functions
Function, r-add-header: Private ordinary functions
Function, random-load-system: Public ordinary functions
Function, random-pkg-info: Public ordinary functions
Function, random-pkg-with-nr-of-ext-symbols: Public ordinary functions
Function, random-sys-info: Public ordinary functions
Function, readme-text: Private ordinary functions
Function, remove-empty-bags: Private ordinary functions
Function, select-pkg: Private ordinary functions
Function, show-childreno: Private ordinary functions
Function, show-info: Private ordinary functions
Function, show-info%parser: Private ordinary functions
Function, sorted-symbols-in-a-category: Private ordinary functions
Function, strip-html: Private ordinary functions
Function, symbol-groups: Private ordinary functions
Function, sys2pkg: Private ordinary functions
Function, toggle-alfabeta: Private ordinary functions
Function, toggle-alfabeta%parser: Private ordinary functions
Function, tview: Private ordinary functions

G
Generic Function, (setf abc): Private generic functions
Generic Function, (setf info): Private generic functions
Generic Function, abc: Private generic functions
Generic Function, info: Private generic functions
get-children: Private standalone methods

H
help: Private ordinary functions
help%parser: Private ordinary functions
hierarchical-category: Private ordinary functions
hierarchy-by-name: Private ordinary functions

I
info: Private generic functions
info: Private generic functions
insert-what: Private ordinary functions
insert-what%: Private ordinary functions
insert-what%%: Private ordinary functions
item-name: Public standalone methods
item-name: Public standalone methods

K
key: Private ordinary functions
key%: Private ordinary functions

L
load-package: Private ordinary functions
local-projects: Private ordinary functions
local-projects%parser: Private ordinary functions
local-systems: Public ordinary functions

M
Macro, define-pkg-doc-command: Private macros
Macro, readme-file: Private macros
Macro, sys-info-clim: Private macros
Method, (setf abc): Private generic functions
Method, (setf info): Private generic functions
Method, abc: Private generic functions
Method, children: Public standalone methods
Method, get-children: Private standalone methods
Method, info: Private generic functions
Method, item-name: Public standalone methods
Method, item-name: Public standalone methods
Method, reinitialize-panes-and-layouts: Private standalone methods
Method, update-instance-for-redefined-class: Public standalone methods
modules: Private ordinary functions
modules%parser: Private ordinary functions

P
pack: Private ordinary functions
packages: Private ordinary functions
packages%parser: Private ordinary functions
packages-in-system: Private ordinary functions
parts: Private ordinary functions
pd: Public ordinary functions
pkg-description: Private ordinary functions
pkg-doc: Private ordinary functions
pkg-symbols: Private ordinary functions
pkg-tree: Public ordinary functions
pkg2sys: Private ordinary functions
print-numbered-pkg: Private ordinary functions

Q
ql-apropos: Private ordinary functions
ql-apropos%parser: Private ordinary functions
ql-system-name: Private ordinary functions
quicklisp: Private ordinary functions
quicklisp%parser: Private ordinary functions
quicklisp-systems: Public ordinary functions

R
r-add-header: Private ordinary functions
random-load-system: Public ordinary functions
random-pkg-info: Public ordinary functions
random-pkg-with-nr-of-ext-symbols: Public ordinary functions
random-sys-info: Public ordinary functions
readme-file: Private macros
readme-text: Private ordinary functions
reinitialize-panes-and-layouts: Private standalone methods
remove-empty-bags: Private ordinary functions

S
select-pkg: Private ordinary functions
show-childreno: Private ordinary functions
show-info: Private ordinary functions
show-info%parser: Private ordinary functions
sorted-symbols-in-a-category: Private ordinary functions
strip-html: Private ordinary functions
symbol-groups: Private ordinary functions
sys-info-clim: Private macros
sys2pkg: Private ordinary functions

T
toggle-alfabeta: Private ordinary functions
toggle-alfabeta%parser: Private ordinary functions
tview: Private ordinary functions

U
update-instance-for-redefined-class: Public standalone methods