Описание: пакет mnas-package является основным в системе mnas-package.

Основными функциями в системе являются:

document;
make-codex-graphs;

Перечисленные ниже функции имеют схожий набор аргументов:

document;
make-codex-documentation;
section-system;
section-package;
section-variables;
section-functions;
section-macroses;
section-setf-functions;
section-generics;
section-setf-generics;
section-methods;
section-classes.

Аргументы:

package-name - пакет из которого извлекаются сущности (глобальными переменными, функциями, и т.д. и т.п.);
stream - поток, в который выводятся информация о сущностях;
external - если не nil - в поток выводятся информация о экспортируемых сущностях;
internal - если не nil - в поток выводятся информация о внутренних сущностях;
inherited - если не nil - в поток выводятся информация о заимствованных сущностях;
sort - если не nil - сущности сортируются в алфавитном порядке;
min-doc-length - минимальная длина строки документации, связанной с сущностью, при которой созается ссылка указаение на вставку документации.

Переменные

*internet-hosts*

Описание: параметр *internet-hosts* содержит перечень хостов в доступом в интернет.

*intranet-hosts*

Описание: параметр *intranet-hosts* содержит перечень хостов в доступом в корпоративную сеть.

Функции

copy-doc->public-html(system-name)

Описание: функция copy-doc->public-html выполняет копирование документации системы system-name в каталог ~/public_html/Common-Lisp-Programs.

document(package-name system-name &key (external t) (internal nil) (inherited nil) (sort t) (min-doc-length *min-doc-length*))

Описание: функция document формирует scr-файл (сценарий системы codex), содержащий документацию о пакете package-name и системы системы system-name. Если имя системы равно nil, извлечение связанной с ней документации не выполняется.

Пример использования:

(mnas-package:document :mnas-package :mnas-package) => path_to_mnas-package_system/docs/mnas-package.scr
 (mnas-package:document :mnas-package/view nil) => path_to_mnas-package_system/docs/mnas-package-view.scr

make-codex-graphs(system-designator package-designator &key (external t) (internal t) (inherited nil))

Описание: функция make-codex-graphs создает в каталоге ./docs/build/mnas-package/html gv-файлы и png-файлы, содержащие графы, отображающие завмсимости

классов;
систем;
символов;
вызовов.

make-doc-generics(package class prefix &key (stream t) (min-doc-length *min-doc-length*))

Описание: функция make-doc-methods выводит в поток stream раздел документации, подготовленной для вставки в scr-файл системы документирования codex. Этот раздел содержит обобщенные функции класса class, имена которых начинаются с префикса prefix.

Пример использования:

(make-doc-generics
 (find-package :mnas-package/example)
 (find-class 'mnas-package/example:<c-с-exp>)
 "")

m-a-exp(x y z)

Documentation example for defgeneric m-a-exp ================================================================================

m-b-exp(x y z)

Documentation example for defgeneric m-b-exp ================================================================================

m-c-exp(x y z)

Documentation example for defgeneric m-c-exp ================================================================================

=> #<package "MNAS-PACKAGE">

make-doc-methods(package class prefix &key (stream t) (min-doc-length *min-doc-length*))

Описание: функция make-doc-methods выводит в поток stream раздел документации, подготовленной для вставки в scr-файл системы документирования codex. Этот раздел содержит методы класса class, имена которых начинаются с префикса prefix.

Пример использования:

(make-doc-generics
 (find-package :mnas-package/example)
 (find-class 'mnas-package/example:<c-с-exp>)
 "")
-> 
     No method m-a-exp with the lambda list ((x <c-a-int>) (y <c-b-int>) (z <c-с-exp>)) found.
     No method m-b-exp with the lambda list ((x <c-a-int>) (y <c-b-int>) (z <c-с-exp>)) found.
     No method m-c-exp with the lambda list ((x <c-a-int>) (y <c-b-int>) (z <c-с-exp>)) found.
=> #<package "MNAS-PACKAGE">

make-html-path(system)

Описание: функция make-html-path в качестве побочного эффекта создает каталог, в который система codex выводит html-докуметы.

rsync-doc(system-name)

Описание: функция rsync-doc выполняет копирование документации на удаленный сервер.

sub-class-graph(class &aux (graph (make-instance (quote <graph>))))

Описание: метод sub-class-graph возвращает граф, содержащий иерархию подклассов класса class.

Пример использования:

(mnas-graph:view-graph (sub-class-graph (find-class 'mnas-package/example::<a>)))
 (mnas-graph:view-graph (sub-class-graph (find-class 'list)))

super-class-graph(class &aux (graph (make-instance (quote <graph>))))

Описание: метод sub-class-graph возвращает граф, содержащий иерархию предков для класса class.

Пример использования:

(mnas-graph:view-graph (super-class-graph (find-class 'mnas-package/example:<c>)))
 (mnas-graph:view-graph (super-class-graph (find-class 'list)))

Mnas-Package » MNAS-PACKAGE

Переменные

Функции