ALBERT full listing

Name

ALBERT full listing -- All funcallable objects and all variables

Package Content

Methods

%GET-DEFAULT-DIRECTORY
 (%GET-DEFAULT-DIRECTORY) [function]
Description 

The default directory.

Called By 

GET-SYSTEM-FILES-ASDF

Calls 

DEFAULT-DIRECTORY

Location 

tools/sds-asdf.lisp

%MAKE-DOC-OBJ
 (%MAKE-DOC-OBJ TYPE VAL) [function]
Description 

This basically creates a SDOC-DOC and assigns values to fields

Calls 

(SETF SDOC-DOC.TEXT), (SETF SDOC-DOC.TYPE) and MAKE-SDOC-DOC

Location 

tools/convert.lisp

%MAKE-INFO-OBJ
 (%MAKE-INFO-OBJ TYPE VAL INFO) [function]
Description 

This basically creates a SDOC-INFO and assigns values to fields

Calls 

(SETF SDOC-INFO.INFO), (SETF SDOC-INFO.TYPE), (SETF SDOC-INFO.VALUE) and MAKE-SDOC-INFO

Location 

tools/convert.lisp

ACTUAL-CONTAINER-MATCHING
 (ACTUAL-CONTAINER-MATCHING TABLE NAME FILE DIR ISCLASS) [function]
Calls 

MATCH-TO-SCOPE?, TAB-CATENTRY-SCOPE and TAB-ENTRY-SCOPE

Location 

tools/convert.lisp

ADD-DOCUMENTATION-TO-OBJECT
 (ADD-DOCUMENTATION-TO-OBJECT SOME-KEY THE-INFO) [function]
Description 

goes through a doc entry and adds documentation to applicable objects

Calls 

ADD-DOCUMENTATION, SUBSEQ, TAB-DOCENTRY-CLOSEST and TAB-DOCENTRY-TEXT

Location 

tools/convert.lisp

ADD-TO-MODULE
 (ADD-TO-MODULE MOD-ENTRY OBJ ORIG-OBJ) [function]
Description 

My guess is that the function adds something to a mod-obj

Called By 

PROCESS-CONVERSION-DATA

Calls 

(SETF SDOC-CATEGORY.CONTENT), (SETF SDOC-MODULE.CONTENT), FIND-MATCHING-CONTAINER, FORMAT, SDOC-CATEGORY.CONTENT, SDOC-MODULE.CONTENT, TAB-CATENTRY-CATEGORY, TAB-ENTRY-CATEGORIES, TAB-ENTRY-MODULE and WHEN-VERBOSE

Location 

tools/convert.lisp

CHECK-THROUGH-ENTRIES
 (CHECK-THROUGH-ENTRIES OBJ OBJ-LOC ENTRY-LIST) [function]
Description 

Checks through entries to find fitting documentation for an obj

Called By 

PROCESS-CONVERSION-DATA

Calls 

(SETF TAB-DOCENTRY-CLOSEST), (SETF TAB-DOCENTRY-CLOSEST-LOC), CSF-LOCATION.STARTLINE, PARSE-INTEGER, SDOC-LOCATION.ENDLINE, SDOC-LOCATION.STARTLINE, TAB-DOCENTRY-CLOSEST-LOC, TAB-DOCENTRY-LOC and TYPE-OF

Location 

tools/convert.lisp

CONVERT-CSF-FILE-TO-SDOC
 (CONVERT-CSF-FILE-TO-SDOC CSF-FILE &KEY MODSPEC-FILE MOD-TOP OUT-FILE VERIFY (PRETTIFY T) (MERGE T)) [function]
Description 

converts a CSF-file to SDOC. Returns the SDOC-tree or NIL

Calls 

CONVERT-CSF-TO-SDOC and PARSE-CSF-FILE

Location 

tools/convert.lisp

CONVERT-CSF-LIST
 (CONVERT-CSF-LIST THE-LIST) [function]

CONVERT-CSF-TO-SDOC
 (CONVERT-CSF-TO-SDOC CSF-TREE &KEY MODSPEC-FILE MOD-TOP OUT-FILE VERIFY (PRETTIFY T) (MERGE T)) [function]
Description 

converts a csf-tree to an sdoc-tree

Called By 

CONVERT-CSF-FILE-TO-SDOC and DOCUMENT-FILES

Calls 

APISPEC-XML:MAKE-XML-TOOL, APISPEC-XML:PRINT-AS-XML, FORMAT, MAKE-SDOC-FACTORY, PARSE-MODSPEC-FILE, PRETTIFY-TREE, PROCESS-CONVERSION-DATA, VERIFY-OBJECT and WHEN-VERBOSE

Location 

tools/convert.lisp

COPY-TAB-CATENTRY
 (COPY-TAB-CATENTRY (OBJ TAB-CATENTRY)) [function]

COPY-TAB-DOCENTRY
 (COPY-TAB-DOCENTRY (OBJ TAB-DOCENTRY)) [function]

COPY-TAB-ENTRY
 (COPY-TAB-ENTRY (OBJ TAB-ENTRY)) [function]

CREATE-HASH-FOR-DOC
 (CREATE-HASH-FOR-DOC DOC-OBJECTS) [function]
Description 

Creates and returns an hashtable with all doc-objects with the doc-objects' location.file as key

Called By 

PROCESS-CONVERSION-DATA

Calls 

CSF-COMMENT.LOCATION, CSF-COMMENT.TEXT, CSF-LOCATION.FILE, GETHASH, MAKE-HASH-TABLE and MAKE-TAB-DOCENTRY

Location 

tools/convert.lisp

DOC-OBJECT-P
 (DOC-OBJECT-P X) [function]
Description 

Checks whether a CSF-Comment has documentation. Currently this check is whether * is the first char in the text.

Calls 

CHAR and CSF-COMMENT.TEXT

Location 

tools/convert.lisp

DOCUMENT-FILES
 (DOCUMENT-FILES FILES &KEY (USE-CLEAN-READTABLE T)) [function]
Description 

Documents the list of FILES.

Called By 

DOCUMENT-SYSTEMS

Calls 

ALBERT-SETTING, ALBERT:CONVERT-CSF-TO-SDOC, LISP2CSF:ANALYSE-FILES, SDS-API-CSF:PARSE-CSF-FILE, SDS-API-SDOC:PARSE-SDOC-FILE, SPRES:PRESENT-SDOC, WARN and WHEN-VERBOSE

Location 

tools/sds-asdf.lisp

DOCUMENT-SYSTEMS
 (DOCUMENT-SYSTEMS) [function]
Description 

Produces a DocBook XML file which contains markup that represents packages, methods, classes, functions, etc. extracted from 'systems'.

Calls 

DOCUMENT-FILES, FLATTEN, GET-SYSTEM-FILES, MAPC, MAPCAR and REVERSE

Location 

tools/sds-asdf.lisp

ESTABLISH-COMMENT-PARSER&
 (ESTABLISH-COMMENT-PARSER& KEY FUN) [function]
Description 

Ensures that a given function with accompanying key is ready for use.

Calls 

(SETF GETHASH)

Location 

tools/convert.lisp

FIGURE-OUT-MODULES
 (FIGURE-OUT-MODULES TOPLEVEL-MOD) [function]
Description 

my guess is that it tries to figure out modules and returns a list of SDOC modules.

Called By 

PROCESS-CONVERSION-DATA

Calls 

CONVERT-OBJ, FORMAT, MAKE-SDOC-MODULE, MAKE-SDOC-PACKAGE, MAPCAR, MODSPEC-TOPLEVEL.MODULES, WARN and WHEN-VERBOSE

Location 

tools/convert.lisp

FILTER-COMMENTS-FROM-TREE
 (FILTER-COMMENTS-FROM-TREE TREE-NODE &OPTIONAL PREDICATE) [function]
Description 

Filters away comments from the tree and returns the comments which satisfies the optional predicate. It is destructive to any content-list in tree-node.

Called By 

FILTER-COMMENTS-FROM-TREE and PROCESS-CONVERSION-DATA

Calls 

(SETF SLOT-VALUE), FILTER-COMMENTS-FROM-TREE, FUNCALL, NREVERSE and SLOT-VALUE

Location 

tools/convert.lisp

FIND-ALL-DOCUMENTABLE-OBJS
 (FIND-ALL-DOCUMENTABLE-OBJS SOME-LIST) [function]
Description 

Goes recursively down the list, collecting all objects which may have documentation found in the code.

Called By 

PROCESS-CONVERSION-DATA

Location 

tools/convert.lisp

FIND-AND-PATCH-CSF-OBJ
 (FIND-AND-PATCH-CSF-OBJ OBJ CANDIDATES BASE-TOP) [function]
Description 

Returns result of (patch-csf-obj ..) when an object was patched and :not-patched if it wasn't.

Called By 

MERGE-CSF-INFO

Calls 

CSF-TOPLEVEL.CONTENT, FIND-PATCHABLE-OBJ and PATCH-CSF-OBJ

Location 

tools/linker.lisp

FIND-CATEGORY
 (FIND-CATEGORY NAME ENTRY) [function]
Calls 

TAB-ENTRY-MODULE

Location 

tools/convert.lisp

FIND-GENERIC-PARENT
 (FIND-GENERIC-PARENT OBJ-LIST OBJ) [function]
Calls 

GET-OBJECT-NAME and IS-GENERIC-FUN?

Location 

tools/convert.lisp

GET-COMMENT-PARSER
 (GET-COMMENT-PARSER KEY) [function]
Description 

Returns a parser for comments from a given key.

Called By 

PROCESS-CONVERSION-DATA

Calls 

GETHASH

Location 

tools/convert.lisp

GET-SYSTEM-FILES
 (GET-SYSTEM-FILES SYSTEM) [function]
Description 

Returns a list of files for the system

Called By 

DOCUMENT-SYSTEMS and SHOW-FILES

Calls 

GET-SYSTEM-FILES-ASDF

Location 

tools/sds-asdf.lisp

GET-SYSTEM-FILES-ASDF
 (GET-SYSTEM-FILES-ASDF SYSTEM) [function]
Description 

Returns a list of files for the system

Called By 

GET-SYSTEM-FILES

Calls 

%GET-DEFAULT-DIRECTORY, ALL-ASDF-COMPONENTS, ASDF:COMPONENT-PATHNAME, ASDF:FIND-SYSTEM, BUTLAST, ENOUGH-NAMESTRING, MAKE-PATHNAME, MAPCAR, PATHNAME-DIRECTORY and REMOVE-IF-NOT

Location 

tools/sds-asdf.lisp

GET-SYSTEM-FILES-MKDEFSYS
 (GET-SYSTEM-FILES-MKDEFSYS SYSTEM) [function]
Description 

Returns a list of files for the system

Calls 

ALL-MKDEFSYS-COMPONENTS, MAKE:COMPONENT-FULL-PATHNAME and MAPCAR

Location 

tools/sds-asdf.lisp

GET-SYSTEM-PATHNAME
 (GET-SYSTEM-PATHNAME SYSTEM) [function]
Description 

Returns the path to the system-def.

Called By 

GET-SYSTEM-PATHNAME and REGISTER-ALBERT-SETTINGS-ASDF

Calls 

ASDF:COMPONENT-PATHNAME, ASDF:FIND-SYSTEM and GET-SYSTEM-PATHNAME

Location 

tools/sds-asdf.lisp

MAKE-TAB-CATENTRY
 (MAKE-TAB-CATENTRY)

MAKE-TAB-DOCENTRY
 (MAKE-TAB-DOCENTRY)
Called By 

CREATE-HASH-FOR-DOC

Location 

tools/convert.lisp

MAKE-TAB-ENTRY
 (MAKE-TAB-ENTRY)

MAPAPPEND
 (MAPAPPEND FUNCTION LIST) [function]
Calls 

COERCE

Location 

tools/sds-asdf.lisp

MATCH-TO-SCOPE?
 (MATCH-TO-SCOPE? SCOPE NAME FILE DIR ISCLASS) [function]
Called By 

ACTUAL-CONTAINER-MATCHING

Calls 

FIND, MODSPEC-SCOPE.CLASSES, MODSPEC-SCOPE.DIRECTORIES, MODSPEC-SCOPE.FILES and MODSPEC-SCOPE.PREFIXES

Location 

tools/convert.lisp

MERGE-CSF-INFO
 (MERGE-CSF-INFO FIRST-TREE-LIST SECOND-TREE-LIST) [function]
Description 

Merges the contents of two tree-lists (top-objects), and lets the first have the correct info. Returns the new top-level in a list.

Called By 

LINK-CSF-FILES

Calls 
Location 

tools/linker.lisp

PARSE-JAVADOC-TEXT
 (PARSE-JAVADOC-TEXT TEXT) [function]
Description 

parses a doc-string and returns the content as a list of conses (TAG . CONTENT) where both are text. When TAG is NIL there was no tag (ie. plain text). Using @ to mark a tag in text.

Calls 

NREVERSE, STRING-LEFT-TRIM and SUBSEQ

Location 

tools/convert.lisp

REGISTER-ALBERT-SETTINGS
 (REGISTER-ALBERT-SETTINGS SYSTEM) [function]
Description 

Checks a system for info and registers it as albert-settings.

Calls 

REGISTER-ALBERT-SETTINGS-ASDF

Location 

tools/sds-asdf.lisp

REGISTER-ALBERT-SETTINGS-ASDF
 (REGISTER-ALBERT-SETTINGS-ASDF SYSTEM) [function]
Description 

Checks a system for info and registers it as albert-settings.

Called By 

REGISTER-ALBERT-SETTINGS

Calls 
(SETF ALBERT-SETTING)ASDF:COMPONENT-NAMEASDF:COMPONENT-PROPERTIES
ASDF:COMPONENT-VERSIONASDF:FIND-SYSTEMASDF:SYSTEM-AUTHOR
ASDF:SYSTEM-DESCRIPTIONASDF:SYSTEM-LICENCEASDF:SYSTEM-MAINTAINER
EQUALPERRORGET-SYSTEM-PATHNAME
IGNORE-ERRORSMAPCARSTRING-DOWNCASE
STRING-EQUALWARN 
Location 

tools/sds-asdf.lisp

SEQ-STARTS-AS
 (SEQ-STARTS-AS TEXT PREFIX-STR) [function]
Description 

returns non-nil iff TEXT starts as STR

Calls 

MISMATCH

Location 

tools/convert.lisp

SHOW-FILES
 (SHOW-FILES SYSTEM) [function]
Calls 

FORMAT and GET-SYSTEM-FILES

Location 

tools/sds-asdf.lisp

TAB-CATENTRY-CATEGORY
 (TAB-CATENTRY-CATEGORY (OBJ TAB-CATENTRY)) [function]

(SETF TAB-CATENTRY-CATEGORY)
 ((SETF TAB-CATENTRY-CATEGORY) (OBJ TAB-CATENTRY)) [function]

TAB-CATENTRY-P
 (TAB-CATENTRY-P OBJ) [predicate]

TAB-CATENTRY-SCOPE
 (TAB-CATENTRY-SCOPE (OBJ TAB-CATENTRY)) [function]

(SETF TAB-CATENTRY-SCOPE)
 ((SETF TAB-CATENTRY-SCOPE) (OBJ TAB-CATENTRY)) [function]

TAB-DOCENTRY-CLOSEST
 (TAB-DOCENTRY-CLOSEST (OBJ TAB-DOCENTRY)) [function]

(SETF TAB-DOCENTRY-CLOSEST)
 ((SETF TAB-DOCENTRY-CLOSEST) (OBJ TAB-DOCENTRY)) [function]
Called By 

CHECK-THROUGH-ENTRIES

Location 

tools/convert.lisp

TAB-DOCENTRY-CLOSEST-LOC
 (TAB-DOCENTRY-CLOSEST-LOC (OBJ TAB-DOCENTRY)) [function]

(SETF TAB-DOCENTRY-CLOSEST-LOC)
 ((SETF TAB-DOCENTRY-CLOSEST-LOC) (OBJ TAB-DOCENTRY)) [function]
Called By 

CHECK-THROUGH-ENTRIES

Location 

tools/convert.lisp

TAB-DOCENTRY-LOC
 (TAB-DOCENTRY-LOC (OBJ TAB-DOCENTRY)) [function]

(SETF TAB-DOCENTRY-LOC)
 ((SETF TAB-DOCENTRY-LOC) (OBJ TAB-DOCENTRY)) [function]

TAB-DOCENTRY-P
 (TAB-DOCENTRY-P OBJ) [predicate]

TAB-DOCENTRY-TEXT
 (TAB-DOCENTRY-TEXT (OBJ TAB-DOCENTRY)) [function]

(SETF TAB-DOCENTRY-TEXT)
 ((SETF TAB-DOCENTRY-TEXT) (OBJ TAB-DOCENTRY)) [function]

TAB-ENTRY-CATEGORIES
 (TAB-ENTRY-CATEGORIES (OBJ TAB-ENTRY)) [function]

(SETF TAB-ENTRY-CATEGORIES)
 ((SETF TAB-ENTRY-CATEGORIES) (OBJ TAB-ENTRY)) [function]

TAB-ENTRY-MODULE
 (TAB-ENTRY-MODULE (OBJ TAB-ENTRY)) [function]

(SETF TAB-ENTRY-MODULE)
 ((SETF TAB-ENTRY-MODULE) (OBJ TAB-ENTRY)) [function]

TAB-ENTRY-P
 (TAB-ENTRY-P OBJ) [predicate]

TAB-ENTRY-SCOPE
 (TAB-ENTRY-SCOPE (OBJ TAB-ENTRY)) [function]

(SETF TAB-ENTRY-SCOPE)
 ((SETF TAB-ENTRY-SCOPE) (OBJ TAB-ENTRY)) [function]

Variables

 variable *ACTIVE-LANGUAGE* is of type T
 variable *COMMENT-PARSERS* is of type T
 variable *CURRENT-DOC-PARSER* is of type T
 variable *MODULE-TABLE* is of type T

This documentation was generated 27 Oct 2003 from the original sources by Albert v.0.4.9.