The mnas-package Reference Manual

4.1.1 mnas-package/mnas-package.asd

Source

mnas-package.asd.

Parent Component

mnas-package (system).

ASDF Systems

• mnas-package.
• mnas-package/obj.
• mnas-package/pkg.
• mnas-package/sys.
• mnas-package/make.
• mnas-package/view.
• mnas-package/sec.
• mnas-package/example.

---

4.1.2 mnas-package/src/mnas-package.lisp

Source

mnas-package.asd.

Parent Component

src (module).

Packages

mnas-package.

Public Interface

• *intranet-hosts* (special variable).
• copy-doc->public-html (function).
• document (function).
• find-sources (function).
• make-codex-graphs (function).
• make-doc-generics (function).
• make-doc-methods (function).
• make-html-path (function).
• make-mainfest-lisp (function).
• rsync-doc (function).
• sub-class-graph (function).
• super-class-graph (function).

Internals

• +mainfest-lisp-template+ (special variable).
• codex-build-pathname (function).
• codex-docs-pathname (function).
• codex-html-pathname (function).
• codex-html-pathname/ (function).
• find-all-generics (function).
• find-all-methods (function).
• make-codex-documentation (function).
• mk-pathname (function).
• remove-msys-prefix (function).

---

4.1.3 mnas-package/src/mnas-package-doc.lisp

Dependency

mnas-package.lisp (file).

Source

mnas-package.asd.

Parent Component

src (module).

Internals

• find-slot (function).
• make-doc (macro).

---

4.1.4 mnas-package/obj/src/obj/obj.lisp

Source

mnas-package.asd.

Parent Component

src/obj (module).

Packages

mnas-package/obj.

Public Interface

• obj-name (generic function).
• obj-name-string (generic function).
• obj-package (generic function).
• obj-package-string (generic function).

---

4.1.5 mnas-package/obj/src/obj/obj-doc.lisp

Source

mnas-package.asd.

Parent Component

src/obj (module).

Internals

• find-slot (function).
• make-doc (macro).

---

4.1.6 mnas-package/pkg/src/pkg/pkg.lisp

Source

mnas-package.asd.

Parent Component

src/pkg (module).

Packages

mnas-package/pkg.

Public Interface

• dependencies-of (generic function).
• dependency-tree (generic function).
• filter-functions (function).
• filter-generics (function).
• filter-macroses (function).
• filter-methods (function).
• filter-setf-functions (function).
• filter-setf-generics (function).
• filter-setf-methods (function).
• filter-variables (function).
• func-to-string (function).
• package-classes (function).
• package-functions (function).
• package-generics (function).
• package-macroses (function).
• package-methods (function).
• package-setf-functions (function).
• package-setf-generics (function).
• package-setf-methods (function).
• package-symbols-by-category (function).
• package-variables (function).
• who-calls-lst (function).
• who-references-lst (function).

Internals

• ->key (generic function).
• defu-defm-name (function).
• ordered-dep-tree (function).
• package-symbols-all (function).
• who-calls (function).
• who-references (function).

---

4.1.7 mnas-package/pkg/src/pkg/pkg-doc.lisp

Dependency

pkg.lisp (file).

Source

mnas-package.asd.

Parent Component

src/pkg (module).

Internals

• find-slot (function).
• make-doc (macro).

---

4.1.8 mnas-package/sys/src/sys/sys.lisp

Source

mnas-package.asd.

Parent Component

src/sys (module).

Packages

mnas-package/sys.

Public Interface

version (function).

---

4.1.9 mnas-package/sys/src/sys/sys-doc.lisp

Dependency

sys.lisp (file).

Source

mnas-package.asd.

Parent Component

src/sys (module).

Internals

• find-slot (function).
• make-doc (macro).

---

4.1.10 mnas-package/make/src/make/make.lisp

Source

mnas-package.asd.

Parent Component

src/make (module).

Packages

mnas-package/make.

Public Interface

• call-graph (function).
• class-graph (function).
• class-slot-graph (function).
• generic-graph (function).
• symbol-graph (function).
• system-graph (function).

---

4.1.11 mnas-package/make/src/make/make-doc.lisp

Dependency

make.lisp (file).

Source

mnas-package.asd.

Parent Component

src/make (module).

Internals

• find-slot (function).
• make-doc (macro).

---

4.1.12 mnas-package/view/src/view/view.lisp

Source

mnas-package.asd.

Parent Component

src/view (module).

Packages

mnas-package/view.

Public Interface

• call-graph (function).
• class-graph (function).
• class-slot-graph (function).
• generic-graph (function).
• symbol-graph (function).
• system-graph (function).

---

4.1.13 mnas-package/view/src/view/view-doc.lisp

Dependency

view.lisp (file).

Source

mnas-package.asd.

Parent Component

src/view (module).

Internals

• find-slot (function).
• make-doc (macro).

---

4.1.14 mnas-package/sec/src/sec/sec.lisp

Source

mnas-package.asd.

Parent Component

src/sec (module).

Packages

mnas-package/sec.

Public Interface

• *min-doc-length* (special variable).
• insert-codex-doc (generic function).
• section-classes (function).
• section-functions (function).
• section-generics (function).
• section-macroses (function).
• section-methods (function).
• section-package (function).
• section-setf-functions (function).
• section-setf-generics (function).
• section-setf-methods (function).
• section-system (function).
• section-variables (function).
• with-downcase (macro).
• with-package (macro).

---

4.1.15 mnas-package/sec/src/sec/sec-doc.lisp

Dependency

sec.lisp (file).

Source

mnas-package.asd.

Parent Component

src/sec (module).

Internals

• find-slot (function).
• make-doc (macro).

---

4.1.16 mnas-package/example/src/example/example.lisp

Source

mnas-package.asd.

Parent Component

src/example (module).

Packages

mnas-package/example.

Public Interface

• *v-a-exp* (special variable).
• *v-b-exp* (special variable).
• *v-c-exp* (special variable).
• <c-a-exp> (class).
• <c-b-exp> (class).
• <c-c-exp> (class).
• f-a-exp (function).
• (setf f-a-exp) (function).
• f-b-exp (function).
• (setf f-b-exp) (function).
• f-c-exp (function).
• (setf f-c-exp) (function).
• k-a-exp (macro).
• k-b-exp (macro).
• k-c-exp (macro).
• m-a-exp (generic function).
• (setf m-a-exp) (generic function).
• m-b-exp (generic function).
• (setf m-b-exp) (generic function).
• m-c-exp (generic function).
• (setf m-c-exp) (generic function).
• print-object (method).
• print-object (method).
• print-object (method).

Internals

• *v-a-int* (special variable).
• *v-b-int* (special variable).
• *v-c-int* (special variable).
• <c-a-int> (class).
• <c-a-int>-a (reader method).
• (setf <c-a-int>-a) (writer method).
• <c-b-int> (class).
• <c-b-int>-b (reader method).
• (setf <c-b-int>-b) (writer method).
• <c-c-int> (class).
• <c-c-int>-c (reader method).
• (setf <c-c-int>-c) (writer method).
• f-a-int (function).
• f-b-int (function).
• f-c-int (function).
• k-a-int (macro).
• k-b-int (macro).
• k-c-int (macro).
• m-a-int (generic function).
• m-b-int (generic function).
• m-c-int (generic function).

---

6.1.1 Special variables

Special Variable: *intranet-hosts* ¶

@b(Описание:) переменная @b(*intranet-hosts*) определяет имена хостов, на которых нет выхода в Интернет.

Package

mnas-package.

Source

mnas-package.lisp.

Special Variable: *min-doc-length* ¶

@b(Описание:) переменная (*min-doc-length*) устанавливает длину строки, свыше которой осуществляется вставка инструкций на генерирование документации для соответствующего объекта.

Package

mnas-package/sec.

Source

sec.lisp.

Special Variable: *v-a-exp* ¶

Documentation example for variable @b(*v-a-exp*) ================================================================================

Package

mnas-package/example.

Source

example.lisp.

Special Variable: *v-b-exp* ¶

Documentation example for variable @b(*v-b-exp*) ================================================================================

Package

mnas-package/example.

Source

example.lisp.

Special Variable: *v-c-exp* ¶

Documentation example for variable @b(*v-c-exp*) ================================================================================

Package

mnas-package/example.

Source

example.lisp.

---

6.1.2 Macros

Macro: k-a-exp (a b) ¶

Documentation example for macro k-a-exp ===================================================================

Package

mnas-package/example.

Source

example.lisp.

Macro: k-b-exp (a b) ¶

Documentation example for macro k-b-exp ===================================================================

Package

mnas-package/example.

Source

example.lisp.

Macro: k-c-exp (a b) ¶

Documentation example for macro k-c-exp ===================================================================

Package

mnas-package/example.

Source

example.lisp.

Macro: with-downcase (&body body) ¶

Not yet documented

Package

mnas-package/sec.

Source

sec.lisp.

Macro: with-package (package-new &body body) ¶

Not yet documented

Package

mnas-package/sec.

Source

sec.lisp.

---

6.1.3 Ordinary functions

Function: call-graph (package-name &key fpath fname graphviz-prg out-type dpi viewer system-name) ¶

@b(Описание:) функция @b(call-graph) выполняет визуализацию графа вызовов пакета @b(package-name).

@b(Пример использования:)
@begin[lang=lisp](code)
(call-graph :mnas-package)
@end(code)

Package

mnas-package/view.

Source

view.lisp.

Function: call-graph (package-name) ¶

@b(Описание:) функция @b(call-graph) возвращает граф вызовов пакета @b(package-name).

@b(Пример использования:)
@begin[lang=lisp](code)
(mnas-package:make-call-graph :mnas-package)
@end(code)

Package

mnas-package/make.

Source

make.lisp.

Function: class-graph (package-name &key external internal inherited fpath fname graphviz-prg out-type dpi viewer) ¶

@b(Описание:) функция @b(class-graph) выводит визуальное представление иерархии классов (графа наследования).

@b(Пример использования:)
@begin[lang=lisp](code)
(mnas-package:mnas-package-demo-11)
@end(code)

Package

mnas-package/view.

Source

view.lisp.

Function: class-graph (package-name &key external internal inherited) ¶

@b(Описание:) функция @b(class-graph) создает граф наследования классов.

@b(Пример использования:)
@begin[lang=lisp](code)
(class-graph :mnas-package )
@end(code)

Package

mnas-package/make.

Source

make.lisp.

Function: class-slot-graph (class &key fpath fname graphviz-prg out-type dpi viewer) ¶

@b(Описание:) функция @b(class-slot-graph) - ...

Package

mnas-package/view.

Source

view.lisp.

Function: class-slot-graph (class) ¶

@b(Описание:) функция @b(class-slot-graph) создает граф слотов класса
с именем @b(class-name).

@b(Пример использования:)
@begin[lang=lisp](code)
(require :temperature-fild)
(mnas-graph:view-graph (class-slot-graph (find-class ’temperature-fild/sector:<sector>))) @end(code)

Package

mnas-package/make.

Source

make.lisp.

Function: copy-doc->public-html (system-name) ¶

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

Package

mnas-package.

Source

mnas-package.lisp.

Function: document (package-name system-name &key external internal inherited sort min-doc-length) ¶

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

@b(Пример использования:)
@begin[lang=lisp](code)
(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 @end(code)

Package

mnas-package.

Source

mnas-package.lisp.

Function: f-a-exp () ¶

Documentation example for function @b(f-a-exp) ================================================================================

Package

mnas-package/example.

Source

example.lisp.

Function: (setf f-a-exp) (lst n) ¶

Documentation example for function @b((setf f-b-exp)) ================================================================================

Package

mnas-package/example.

Source

example.lisp.

Function: f-b-exp () ¶

Documentation example for function @b(f-b-exp) ================================================================================

Package

mnas-package/example.

Source

example.lisp.

Function: (setf f-b-exp) (lst n) ¶

Documentation example for function @b((setf f-b-exp)) ================================================================================

Package

mnas-package/example.

Source

example.lisp.

Function: f-c-exp () ¶

Documentation example for function @b(f-c-exp) ================================================================================

Package

mnas-package/example.

Source

example.lisp.

Function: (setf f-c-exp) (lst n) ¶

Documentation example for function @b((setf f-b-exp)) ================================================================================

Package

mnas-package/example.

Source

example.lisp.

Function: filter-functions (symbols) ¶

@b(Описание:) функция filter-functions возвращает список символов, являющихся сопряженными с функциями.

@b(Переменые:)
@begin(list)
@item(symbols - список символов пакета.)
@end(list)

Package

mnas-package/pkg.

Source

pkg.lisp.

Function: filter-generics (symbols) ¶

@b(Описание:) функция @b(filter-generics) возвращает список символов сопряженных с обобщеными функциями.

@b(Переменые:)
@begin(list)
@item(symbols - список символов пакета.)
@end(list)

Package

mnas-package/pkg.

Source

pkg.lisp.

Function: filter-macroses (symbols) ¶

@b(Описание:) функция filter-functions возвращает список символов сопряженных с макросами.

@b(Переменые:) @begin(list) @item(symbols - список символов пакета.) @end(list)

Package

mnas-package/pkg.

Source

pkg.lisp.

Function: filter-methods (methods) ¶

@b(Описание:) функция @b(filter-methods) возвращает список символов, являющихся сопряженными с setf-методами.

@b(Переменые:)
@begin(list)
@item(symbols - список символов пакета.)
@end(list)

Package

mnas-package/pkg.

Source

pkg.lisp.

Function: filter-setf-functions (symbols) ¶

@b(Описание:) функция filter-functions возвращает список символов, являющихся сопряженными с setf-функциями.

@b(Переменые:)
@begin(list)
@item(symbols - список символов пакета.)
@end(list)

Package

mnas-package/pkg.

Source

pkg.lisp.

Function: filter-setf-generics (symbols) ¶

@b(Описание:) функция @b(filter-setf-generics) возвращает список символов, являющихся сопряженными с обобщенными setf-функциями.

@b(Переменые:)
@begin(list)
@item(symbols - список символов пакета.)
@end(list)

Package

mnas-package/pkg.

Source

pkg.lisp.

Function: filter-setf-methods (methods) ¶

@b(Описание:) функция @b(filter-setf-methods) возвращает список символов, являющихся сопряженными с setf-методами.

@b(Переменые:)
@begin(list)
@item(symbols - список символов пакета.)
@end(list)

Package

mnas-package/pkg.

Source

pkg.lisp.

Function: filter-variables (symbols) ¶

@b(Описание:) функция filter-variables возвращает список символов, являющихся сопряженными со значениями.

@b(Переменые:)
@begin(list)
@item(symbols - список символов пакета.)
@end(list)

Package

mnas-package/pkg.

Source

pkg.lisp.

Function: find-sources (system) ¶

Package

mnas-package.

Source

mnas-package.lisp.

Function: func-to-string (func) ¶

Not yet documented

Package

mnas-package/pkg.

Source

pkg.lisp.

Function: generic-graph (generic &key fpath fname graphviz-prg out-type dpi viewer) ¶

Not yet documented

Package

mnas-package/view.

Source

view.lisp.

Function: generic-graph (generic) ¶

@b(Описание:) функция @b(generic-graph) возвращает граф параметров обобщенной функций.

Данный граф должен быть трехуровневым:
@begin(list)
@item(первый уровень - обобщенная функция;)
@item(второй - номер по порядку для обязательного параметра и его имя; ) @item(третий - тип обязательного параметра.)
@end(list)

@b(Пример использования:)
@begin[lang=lisp](code)

@end(code)

Package

mnas-package/make.

Source

make.lisp.

Function: make-codex-graphs (system-designator package-designator &key external internal inherited) ¶

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

Package

mnas-package.

Source

mnas-package.lisp.

Function: make-doc-generics (package class prefix &key stream min-doc-length) ¶

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

@b(Пример использования:)
@begin[lang=lisp](code)
(make-doc-generics
(find-package :mnas-package/example)
(find-class ’mnas-package/example:<c-с-exp>)
"")
@end(code)
-> @cl:with-package[name="MNAS-PACKAGE/EXAMPLE"]( @cl:doc(generic m-a-exp)
@cl:doc(generic m-b-exp)
@cl:doc(generic m-c-exp))
=> #<package "MNAS-PACKAGE">

Package

mnas-package.

Source

mnas-package.lisp.

Function: make-doc-methods (package class prefix &key stream min-doc-length) ¶

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

@b(Пример использования:)
@begin[lang=lisp](code)
(make-doc-generics
(find-package :mnas-package/example)
(find-class ’mnas-package/example:<c-с-exp>)
"")
-> @cl:with-package[name="MNAS-PACKAGE/EXAMPLE"](
@cl:doc(method m-a-exp (x <c-a-int>) (y <c-b-int>) (z <c-с-exp>)) @cl:doc(method m-b-exp (x <c-a-int>) (y <c-b-int>) (z <c-с-exp>)) @cl:doc(method m-c-exp (x <c-a-int>) (y <c-b-int>) (z <c-с-exp>))) => #<package "MNAS-PACKAGE">
@end(code)

Package

mnas-package.

Source

mnas-package.lisp.

Function: make-html-path (system) ¶

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

@b(Пример использования:)
@begin[lang=lisp](code)
(make-html-path :mnas-path)
@end(code)

Package

mnas-package.

Source

mnas-package.lisp.

Function: make-mainfest-lisp (systems title authors sources &key output-format) ¶

@b(Описание:) функция @b(make-mainfest-lisp) создает файл @i(docs/manifest.lisp).

@b(Переменые:)
@begin(list)
@item(systems - список систем;)
@item(title - заголовок;)
@item(authors - список авторов;)
@item(sources - список исходных файлов;) @item(output-format - атрибуты формата вывода.) @end(list)

@b(Пример использования:)
@begin[lang=lisp](code)
(make-mainfest-lisp
’(:MNAS-PACKAGE)
"Mnas-Package"
’("Mykola Matvyeyev")
’("mnas-file-dialog.scr" "mnas-file-dialog-graph.scr")) @end(code)

Package

mnas-package.

Source

mnas-package.lisp.

Function: package-classes (package-name &key external internal inherited) ¶

@b(Описание:) package-classes возвращает список классов пакета.

@b(Пример использования:)
@begin[lang=lisp](code)
(package-classes :mnas-package/example) => (#<STANDARD-CLASS MNAS-PACKAGE/EXAMPLE:<C>>) (package-classes :mnas-package/example :external nil :internal t)
=> (#<STANDARD-CLASS MNAS-PACKAGE/EXAMPLE::<A>>
#<STANDARD-CLASS MNAS-PACKAGE/EXAMPLE::<B>>
#<STANDARD-CLASS MNAS-PACKAGE/EXAMPLE::<B-SHORT>>
#<STANDARD-CLASS MNAS-PACKAGE/EXAMPLE::<C-SHORT>>
#<STANDARD-CLASS MNAS-PACKAGE/EXAMPLE::<A-SHORT>>)
@end(code)

Package

mnas-package/pkg.

Source

pkg.lisp.

Function: package-functions (package-name &key external internal inherited) ¶

@b(Описание:) функция @b(package-functions) возвращает список функций пакета @b(package-name).

@b(Пример использования:)
@begin[lang=lisp](code)
(package-functions :mnas-package/example :internal t)
=> (#<FUNCTION MNAS-PACKAGE/EXAMPLE:BAZ-SHORT> #<FUNCTION MNAS-PACKAGE/EXAMPLE:BAZ>) @end(code)

Package

mnas-package/pkg.

Source

pkg.lisp.

Function: package-generics (package-name &key external internal inherited) ¶

@b(Описание:) функция @b(package-generics) возвращает список обобщенных функций пакета @b(package-name).

@b(Пример использования:)
@begin[lang=lisp](code)
(package-generics :mnas-package/example :internal t)
=> (#<STANDARD-GENERIC-FUNCTION MNAS-PACKAGE/EXAMPLE:M-C-EXP (1)> #<STANDARD-GENERIC-FUNCTION MNAS-PACKAGE/EXAMPLE:M-B-EXP (1)> #<STANDARD-GENERIC-FUNCTION MNAS-PACKAGE/EXAMPLE:M-A-EXP (1)> #<STANDARD-GENERIC-FUNCTION MNAS-PACKAGE/EXAMPLE::<C-C-INT>-C (1)> #<STANDARD-GENERIC-FUNCTION MNAS-PACKAGE/EXAMPLE::<C-B-INT>-B (1)> #<STANDARD-GENERIC-FUNCTION MNAS-PACKAGE/EXAMPLE::<C-A-INT>-A (1)>) @end(code)

Package

mnas-package/pkg.

Source

pkg.lisp.

Function: package-macroses (package-name &key external internal inherited) ¶

@b(Описание:) функция @b(package-macroses) возвращает список
макросов пакета @b(package-name).

@b(Пример использования:)
@begin[lang=lisp](code)
(package-macroses :mnas-package/example :internal t)
=> (#<FUNCTION (MACRO-FUNCTION MNAS-PACKAGE/EXAMPLE::MAK-A-SHORT) {52D45ECB}> #<FUNCTION (MACRO-FUNCTION MNAS-PACKAGE/EXAMPLE::MAK-A) {52D454BB}>) @end(code)

Package

mnas-package/pkg.

Source

pkg.lisp.

Function: package-methods (package-name &key external internal inherited) ¶

@b(Описание:) функция @b(package-methods) возвращает список методов пакета
@b(package-name).

@b(Пример использования:)
@begin[lang=lisp](code)
(package-methods :mnas-package/example :internal t)
(#<STANDARD-METHOD MNAS-PACKAGE/EXAMPLE:M-A-EXP (MNAS-PACKAGE/EXAMPLE::<C-A-INT> MNAS-PACKAGE/EXAMPLE::<C-B-INT> MNAS-PACKAGE/EXAMPLE:<C-C-EXP>) {1004634963}> #<STANDARD-METHOD MNAS-PACKAGE/EXAMPLE:M-B-EXP (MNAS-PACKAGE/EXAMPLE::<C-A-INT> MNAS-PACKAGE/EXAMPLE::<C-B-INT> MNAS-PACKAGE/EXAMPLE:<C-C-EXP>) {1004634983}> #<STANDARD-METHOD MNAS-PACKAGE/EXAMPLE:M-C-EXP (MNAS-PACKAGE/EXAMPLE::<C-A-INT> MNAS-PACKAGE/EXAMPLE::<C-B-INT> MNAS-PACKAGE/EXAMPLE::<C-C-INT>) {10046349A3}> #<STANDARD-METHOD MNAS-PACKAGE/EXAMPLE:M-C-EXP (MNAS-PACKAGE/EXAMPLE:<C-A-EXP> MNAS-PACKAGE/EXAMPLE:<C-B-EXP> MNAS-PACKAGE/EXAMPLE:<C-C-EXP>) {10049D5BD3}>)

@end(code)

Package

mnas-package/pkg.

Source

pkg.lisp.

Function: package-setf-functions (package-name &key external internal inherited) ¶

@b(Описание:) функция @b(package-setf-functions) возвращает список setf-функций пакета @b(package-name).

@b(Пример использования:) @begin[lang=lisp](code) (package-setf-functions :mnas-package/example :internal t)
=> (#<FUNCTION (SETF MNAS-PACKAGE/EXAMPLE::FOO)>)
@end(code)

Package

mnas-package/pkg.

Source

pkg.lisp.

Function: package-setf-generics (package-name &key external internal inherited) ¶

@b(Описание:) функция @b(package-setf-generics) возвращает список функций пакета @b(package-name).

@b(Пример использования:) @begin[lang=lisp](code)
(package-setf-functions :mnas-package/example :internal t)
=> (#<FUNCTION (SETF MNAS-PACKAGE/EXAMPLE::FOO)>)
@end(code)

Package

mnas-package/pkg.

Source

pkg.lisp.

Function: package-setf-methods (package-name &key external internal inherited) ¶

@b(Описание:) функция @b(package-setf-methods) возвращает список setf-методов пакета
@b(package-name).

@b(Пример использования:)
@begin[lang=lisp](code)
(package-setf-methods :mnas-package/example :internal t)
(#<STANDARD-METHOD MNAS-PACKAGE/EXAMPLE::M-FOO :AROUND (MNAS-PACKAGE/EXAMPLE::<A> MNAS-PACKAGE/EXAMPLE::<B> T) {10019B69A3}>
...
#<STANDARD-METHOD MNAS-PACKAGE/EXAMPLE::M-FOO-SHORT (MNAS-PACKAGE/EXAMPLE::<A> MNAS-PACKAGE/EXAMPLE::<B> MNAS-PACKAGE/EXAMPLE:<C>) {1001C6CAC3}>) @end(code)

Package

mnas-package/pkg.

Source

pkg.lisp.

Function: package-symbols-by-category (package-name &key external internal inherited) ¶

@b(Описание:) package-symbols-by-category выполнят поиск символов,
определенных пакетом @b(package-name).

@b(Пример использования:)
@begin[lang=lisp](code)
(package-symbols-by-category ’mnas-package :internal nil) ;; отбор только внешних символов; (package-symbols-by-category :mnas-package) ;; отбор внешних и внутренних символов; (package-symbols-by-category "MNAS-PACKAGE" :internal nil :inherited t) ;; отбор только внешних и заимствованных символов; @end(code)

Package

mnas-package/pkg.

Source

pkg.lisp.

Function: package-variables (package-name &key external internal inherited) ¶

@b(Описание:) функция @b(package-variables) возвращает список символов пакета @b(package-name).

@b(Пример использования:)
@begin[lang=lisp](code)
(package-variables :mnas-package :inherited t)
@end(code)

Package

mnas-package/pkg.

Source

pkg.lisp.

Function: rsync-doc (system-name) ¶

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

@b(Пример использования:)
@begin[lang=lisp](code)
(rsync-doc "mnas-package")
@end(code)

Package

mnas-package.

Source

mnas-package.lisp.

Function: section-classes (package-name &key stream external internal inherited sort min-doc-length) ¶

@b(Описание:) функция @b(section-classes) выводит в поток @b(stream)
секцию с документацией в формате codex, содержащую классы из пакета @b(package-name).

@b(Пример использования:)
@begin[lang=lisp](code)
(require :dxf)
(section-classes :dxf :internal t)
@end(code)

Package

mnas-package/sec.

Source

sec.lisp.

Function: section-functions (package-name &key stream external internal inherited sort min-doc-length) ¶

@b(Описание:) функция @b(section-functions) выводит в поток stream секцию с документацией в формате codex, содержащую функции из пакета package-name.

@b(Пример использования:)
@begin[lang=lisp](code)
(section-functions :math/stat :external t :internal t :sort t) @end(code)

Package

mnas-package/sec.

Source

sec.lisp.

Function: section-generics (package-name &key stream external internal inherited sort min-doc-length) ¶

@b(Описание:) функция @b(section-generics) выводит в поток stream
секцию с документацией в формате codex, содержащую обобщенные функции из пакета @b(package-name).

@b(Пример использования:)
@begin[lang=lisp](code)
(section-generics :mnas-package/example :internal t :sort t)
@end(code)

Package

mnas-package/sec.

Source

sec.lisp.

Function: section-macroses (package-name &key stream external internal inherited sort min-doc-length) ¶

@b(Описание:) функция @b(section-macroses) выводит в поток stream
секцию с документацией в формате codex, содержащую макросы из пакета
package-name.

@b(Пример использования:)
@begin[lang=lisp](code)
(section-macroses :mnas-package/example :external t :internal t :sort t) (section-macroses :mnas-package/example :external t :internal t :sort t :min-doc-length 10) @end(code)

Package

mnas-package/sec.

Source

sec.lisp.

Function: section-methods (package-name &key stream external internal inherited sort min-doc-length) ¶

@b(Описание:) функция @b(section-methods) выводит в поток @b(stream)
секцию с документацией в формате codex, содержащую методы из пакета @b(package-name).

@b(Пример использования:)
@begin[lang=lisp](code)
(section-methods :mnas-package/example :internal t)
@end(code)

Package

mnas-package/sec.

Source

sec.lisp.

Function: section-package (package-name &key stream external internal inherited sort min-doc-length) ¶

@b(Описание:) функция @b(section-package)

@b(Пример использования:) @begin[lang=lisp](code) (section-package :mnas-package) @end(code)

Package

mnas-package/sec.

Source

sec.lisp.

Function: section-setf-functions (package-name &key stream external internal inherited sort min-doc-length) ¶

@b(Описание:) функция @b(section-setf-functions) выводит в поток stream
секцию с документацией в формате codex, содержащую setf-функции из пакета package-name.

@b(Пример использования:)
@begin[lang=lisp](code)
(section-setf-functions :mnas-package/example :external t :internal t :sort t) (section-setf-functions :mnas-package/example :external t :internal t :sort nil) @end(code)

Package

mnas-package/sec.

Source

sec.lisp.

Function: section-setf-generics (package-name &key stream external internal inherited sort min-doc-length) ¶

@b(Описание:) функция @b(section-setf-generics) выводит в поток stream
секцию с документацией в формате codex, содержащую обощенные setf-функции из пакета package-name.

@b(Пример использования:)
@begin[lang=lisp](code)
(section-setf-generics :mnas-package/example :external t :internal t :sort nil) (section-setf-generics :mnas-package/example :external t :internal t :sort t)
@end(code)

Package

mnas-package/sec.

Source

sec.lisp.

Function: section-setf-methods (package-name &key stream external internal inherited sort min-doc-length) ¶

@b(Описание:) функция @b(section-setf-methods) выводит в поток @b(stream) секцию с документацией в формате codex, содержащую setf-методы из пакета @b(package-name).

@b(Пример использования:)
@begin[lang=lisp](code)
(section-setf-methods :mnas-package/example :internal t :sort nil) @end(code)

Package

mnas-package/sec.

Source

sec.lisp.

Function: section-system (system-name &key stream) ¶

@b(Описание:) функция @b(section-system)

@b(Пример использования:) @begin[lang=lisp](code)

@end(code)

Package

mnas-package/sec.

Source

sec.lisp.

Function: section-variables (package-name &key stream external internal inherited sort min-doc-length) ¶

@b(Описание:) функция @b(section-classes) выводит в поток @b(stream)
секцию с документацией в формате codex, содержащую переменные из пакета @b(package-name).

@b(Пример использования:)
@begin[lang=lisp](code)
(require :dxf)
(section-classes :dxf :internal t)
@end(code)

Package

mnas-package/sec.

Source

sec.lisp.

Function: sub-class-graph (class) ¶

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

@b(Пример использования:)
@begin[lang=lisp](code)
(mnas-graph:view-graph (sub-class-graph (find-class ’mnas-package/example::<a>))) (mnas-graph:view-graph (sub-class-graph (find-class ’list)))
@end(code)

Package

mnas-package.

Source

mnas-package.lisp.

Function: super-class-graph (class) ¶

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

@b(Пример использования:)
@begin[lang=lisp](code)
(mnas-graph:view-graph (super-class-graph (find-class ’mnas-package/example:<c>))) (mnas-graph:view-graph (super-class-graph (find-class ’list)))
@end(code)

Package

mnas-package.

Source

mnas-package.lisp.

Function: symbol-graph (package-name &key fpath fname graphviz-prg out-type dpi viewer) ¶

@b(Описание:) функция @b(symbol-graph) отображает граф зависимостей глобальных символов.

Позволяет ответить на вопрос: в какой функции используется тот или
иной глобальный символ.

@b(Пример использования:)
@begin[lang=lisp](code)
(view-symbol-graph :mnas-package)
@end(code)

Package

mnas-package/view.

Source

view.lisp.

Function: symbol-graph (package-name) ¶

@b(Описание:) функция @b(symbol-graph) строит граф использования методпми и функциями внешних символов.

@b(Пример использования:)
@begin[lang=lisp](code)
(symbol-graph :mnas-string)
@end(code)

Package

mnas-package/make.

Source

make.lisp.

Function: system-graph (system &key fpath fname graphviz-prg out-type dpi viewer) ¶

@b(Описание:) функция @b(system-graph) визуализирует граф систем, от которых зависит система @b(system).

@b(Пример использования:)
@begin[lang=lisp](code)
(mnas-package/view:system-graph :mnas-package :out-type "png" :viewer nil) @end(code)

Package

mnas-package/view.

Source

view.lisp.

Function: system-graph (system) ¶

@b(Описание:) функция @b(system-graph) возвращает граф систем, от которых зависит система @b(system).

@b(Пример использования:)
@begin[lang=lisp](code)
(mnas-package/make:system-graph :mnas-package)
@end(code)

Package

mnas-package/make.

Source

make.lisp.

Function: version (system-designator) ¶

@b(Описание:) функция @b(system-version) возвращает версию системы, заданной аргументом @b(system-designator).

Package

mnas-package/sys.

Source

sys.lisp.

Function: who-calls-lst (func-lst) ¶

Not yet documented

Package

mnas-package/pkg.

Source

pkg.lisp.

Function: who-references-lst (var-lst) ¶

Not yet documented

Package

mnas-package/pkg.

Source

pkg.lisp.

---

6.1.4 Generic functions

Generic Function: dependencies-of (system) ¶

Not yet documented

Package

mnas-package/pkg.

Source

pkg.lisp.

Methods

Method: dependencies-of ((system symbol)) ¶

Not yet documented

Generic Function: dependency-tree (system) ¶

Not yet documented

Package

mnas-package/pkg.

Source

pkg.lisp.

Methods

Method: dependency-tree ((system symbol)) ¶

Not yet documented

Generic Function: insert-codex-doc (obj &key stream min-doc-length) ¶

@b(Описание:) обобщенная функция @b(insert-codex-doc)
выводит в поток @b(stream) код для вставки документации, относящейся к объекту @b(obj). Документация объекта выводится в поток только если ее длина превышает @b(min-doc-length).

Возвращает:
@begin(list)
@item(@b(t) - если документация была выведена в поток;) @item(@b(nil) - если документация не была выведена в поток.) @end(list)

Package

mnas-package/sec.

Source

sec.lisp.

Methods

Method: insert-codex-doc ((package package) &key stream min-doc-length) ¶

@b(Пример использования:) @begin[lang=lisp](code) (insert-codex-doc (find-package :mpkg)) @end(code)

Method: insert-codex-doc ((method method) &key stream min-doc-length) ¶

(insert-codex-doc (find-package :mpkg))

Method: insert-codex-doc ((class class) &key stream min-doc-length) ¶

Method: insert-codex-doc ((generic standard-generic-function) &key stream min-doc-length) ¶

Method: insert-codex-doc ((function function) &key stream min-doc-length) ¶

@b(Пример использования:) @begin[lang=lisp](code)

@end(code)

Method: insert-codex-doc ((symbol symbol) &key stream min-doc-length) ¶

@b(Пример использования:)
@begin[lang=lisp](code)
(mapcar #’insert-codex-doc (mpkg/pkg:package-variables :mnas-package/example :internal t)) @end(code)

Generic Function: m-a-exp (x y z) ¶

Documentation example for defgeneric @b(m-a-exp) ================================================================================

Package

mnas-package/example.

Source

example.lisp.

Methods

Method: m-a-exp ((x <c-a-int>) (y <c-b-int>) (z <c-c-exp>)) ¶

Documentation example for method @b(m-a-exp ((x <c-a-int>) (y <c-b-int>) (z <c-c-exp>))) ================================================================================

Generic Function: (setf m-a-exp) (obj) ¶

Documentation example for defgeneric @b((setf m-a-exp)) ================================================================================

Package

mnas-package/example.

Source

example.lisp.

Methods

Method: (setf m-a-exp) ((b <c-b-int>)) ¶

Documentation example for defgeneric @b((setf m-a-exp) ((val number) (b <c-b-int>))) ================================================================================

Method: (setf m-a-exp) ((b <c-b-int>)) ¶

Documentation example for defgeneric @b((setf m-a-exp) (val (b <c-b-int>))) ================================================================================

Method: (setf m-a-exp) ((a <c-a-int>)) ¶

Documentation example for defgeneric @b((setf m-a-exp) ((val number) (a <c-a-int>))) ================================================================================

Method: (setf m-a-exp) ((a <c-a-int>)) ¶

Documentation example for defgeneric @b((setf m-a-exp) (val (a <c-a-int>))) ================================================================================

Generic Function: m-b-exp (x y z) ¶

Documentation example for defgeneric @b(m-b-exp) ================================================================================

Package

mnas-package/example.

Source

example.lisp.

Methods

Method: m-b-exp ((x <c-a-int>) (y <c-b-int>) (z <c-c-exp>)) ¶

Documentation example for method @b(m-b-exp (x <c-a-int>) (y <c-b-int>) (z <c-c-exp>)) ================================================================================

Generic Function: (setf m-b-exp) (obj) ¶

Documentation example for defgeneric @b((setf m-b-exp)) ================================================================================

Package

mnas-package/example.

Source

example.lisp.

Methods

Method: (setf m-b-exp) ((b <c-b-int>)) ¶

Documentation example for defgeneric @b((setf m-b-exp) ((val number) (b <c-b-int>))) ================================================================================

Method: (setf m-b-exp) ((b <c-b-int>)) ¶

Documentation example for defgeneric @b((setf m-b-exp) (val (b <c-b-int>))) ================================================================================

Method: (setf m-b-exp) ((a <c-a-int>)) ¶

Documentation example for defgeneric @b((setf m-b-exp) ((val number) (a <c-a-int>))) ================================================================================

Method: (setf m-b-exp) ((a <c-a-int>)) ¶

Documentation example for defgeneric @b((setf m-b-exp) (val (a <c-a-int>))) ================================================================================

Generic Function: m-c-exp (x y z) ¶

Documentation example for defgeneric @b(m-c-exp) ================================================================================

Package

mnas-package/example.

Source

example.lisp.

Methods

Method: m-c-exp ((x <c-a-exp>) (y <c-b-exp>) (z <c-c-exp>)) ¶

Documentation example for method @b(m-c-exp (x <c-a-int>) (y <c-b-int>) (z <c-c-exp>)) ================================================================================

Method: m-c-exp ((x <c-a-int>) (y <c-b-int>) (z <c-c-int>)) ¶

Documentation example for method @b(m-c-exp (x <c-a-int>) (y <c-b-int>) (z <c-c-exp>)) ================================================================================

Generic Function: (setf m-c-exp) (obj) ¶

Documentation example for defgeneric @b((setf m-c-exp)) ================================================================================

Package

mnas-package/example.

Source

example.lisp.

Methods

Method: (setf m-c-exp) ((b <c-b-int>)) ¶

Documentation example for defgeneric @b((setf m-c-exp) ((val number) (b <c-b-int>))) ================================================================================

Method: (setf m-c-exp) ((b <c-b-int>)) ¶

Documentation example for defgeneric @b((setf m-c-exp) (val (b <c-b-int>))) ================================================================================

Method: (setf m-c-exp) ((a <c-a-int>)) ¶

Documentation example for defgeneric @b((setf m-c-exp) ((val number) (a <c-a-int>))) ================================================================================

Method: (setf m-c-exp) ((a <c-a-int>)) ¶

Documentation example for defgeneric @b((setf m-c-exp) (val (a <c-a-int>))) ================================================================================

Generic Function: obj-name (obj) ¶

@b(Описание:) обобщенная функция @b(obj-name) возвращает символ, представляющий имя объекта obj.

Package

mnas-package/obj.

Source

obj.lisp.

Methods

Method: obj-name ((slot-definition slot-definition)) ¶

@b(Описание:) метод @b(obj-name) возвращает символ, представляющий имя определеия слота.

Method: obj-name ((package package)) ¶

@b(Описание:) метод @b(obj-name) возвращает символ, представляющий имя класса.

@b(Пример использования:) @begin[lang=lisp](code)
(obj-name (find-package :dxf))
@end(code)

Method: obj-name ((class class)) ¶

@b(Описание:) метод @b(obj-name) возвращает символ, представляющий имя класса.

@b(Пример использования:)
@begin[lang=lisp](code)
(obj-name (first (package-classes :dxf :internal t))) @end(code)

Method: obj-name ((method method)) ¶

@b(Описание:) метод @b(obj-name) возвращает символ,
представляющий имя метода.

@b(Пример использования:)
@begin[lang=lisp](code)
(require :dxf)
(obj-name (second (closer-mop:generic-function-methods (first (package-generics :dxf))))) @end(code)

Method: obj-name ((generic standard-generic-function)) ¶

@b(Описание:) метод @b(obj-name) возвращает символ, представляющий имя обобщенной функции.

Вторым значением возвращается:
@begin(list)
@item(:generic - для обыкновенной обобщенной функции;) @item(:setf-generic - для setf обобщенной функции.) @end(list)

Method: obj-name ((function function)) ¶

@b(Описание:) метод @b(obj-name) возвращает символ, представляющий имя функции.

@b(Пример использования:)
@begin[lang=lisp](code)
(obj-name (second (package-functions :mnas-package))) @end(code)

Method: obj-name ((symbol symbol)) ¶

@b(Описание:) метод @b(obj-name) возвращает символ, представляющий имя символа.

Generic Function: obj-name-string (obj) ¶

@b(Описание:) обобщенная функция @b(obj-name-string) возвращает строку, представляую имя объекта obj.

Package

mnas-package/obj.

Source

obj.lisp.

Methods

Method: obj-name-string (obj) ¶

@b(Описание:) метод @b(obj-name) возвращает строку,
представляющую имя функции.

@b(Пример использования:)
@begin[lang=lisp](code)
(progn
(require :dxf)
(obj-name-string (second (package-functions :mnas-package)))
(obj-name-string (second (package-functions :dxf)))
(obj-name (first (package-generics :dxf)))
(obj-name (second (closer-mop:generic-function-methods (first (package-generics :dxf)))))) @end(code)

Generic Function: obj-package (obj) ¶

@b(Описание:) обобщенная функция @b(obj-package) возвращает пакет, в котором определен объект obj.

Package

mnas-package/obj.

Source

obj.lisp.

Methods

Method: obj-package ((slot-definition slot-definition)) ¶

@b(Описание:) метод @b(obj-package) возвращает символ, представляющий имя определение слота.

Method: obj-package ((package package)) ¶

@b(Описание:) метод @b(obj-package) возвращает символ, представляющий имя пакета.

@b(Пример использования:)
@begin[lang=lisp](code)
(require :dxf)
(obj-package (find-package :dxf))
@end(code)

Method: obj-package ((class class)) ¶

@b(Описание:) метод @b(obj-package) возвращает символ, представляющий имя класса.

@b(Пример использования:)
@begin[lang=lisp](code)
(obj-package (first (package-classes :dxf :internal t))) @end(code)

Method: obj-package ((method method)) ¶

@b(Описание:) метод @b(obj-package) возвращает символ,
представляющий имя метода.

@b(Пример использования:)
@begin[lang=lisp](code)
(require :dxf)
(obj-package (second (closer-mop:generic-function-methods (first (package-generics :dxf))))) @end(code)

Method: obj-package ((generic standard-generic-function)) ¶

@b(Описание:) метод @b(obj-package) возвращает символ, представляющий имя обобщенной функции.

@b(Пример использования:)
@begin[lang=lisp](code)
(require :dxf)
(obj-package (first (package-generics :dxf))) @end(code)

Method: obj-package ((function function)) ¶

@b(Описание:) метод @b(obj-package) возвращает символ, представляющий имя функции.

@b(Пример использования:)
@begin[lang=lisp](code)
(obj-package (second (package-functions :mnas-package))) @end(code)

Method: obj-package ((symbol symbol)) ¶

@b(Описание:) метод @b(obj-name) возвращает символ, представляющий имя символа.

Generic Function: obj-package-string (obj) ¶

@b(Описание:) обобщенная функция @b(obj-package-string) возвращает строку, представляющую имя пакета, в котором определен объект @b(obj).

Package

mnas-package/obj.

Source

obj.lisp.

Methods

Method: obj-package-string (obj) ¶

@b(Описание:) метод @b(obj-package-string)
возвращает строку, представляющую имя пакета, в котором определен объект @b(obj).

@b(Пример использования:)
@begin[lang=lisp](code)
(require :dxf)
(obj-package-string (find-package :dxf))
@end(code)

---

6.1.5 Standalone methods

Method: print-object ((c <c-c-int>) s) ¶

Source

example.lisp.

Method: print-object ((a <c-a-int>) s) ¶

Source

example.lisp.

Method: print-object ((b <c-b-int>) s) ¶

Source

example.lisp.

---

6.1.6 Classes

Class: <c-a-exp> ¶

Documentation example for class <c-a-exp> ====================================================================

Package

mnas-package/example.

Source

example.lisp.

Direct superclasses

<c-a-int>.

Direct methods

m-c-exp.

Class: <c-b-exp> ¶

Documentation example for class <c-b-exp> ====================================================================

Package

mnas-package/example.

Source

example.lisp.

Direct superclasses

<c-b-int>.

Direct methods

m-c-exp.

Class: <c-c-exp> ¶

Documentation example for class <c-c-exp> ====================================================================

Package

mnas-package/example.

Source

example.lisp.

Direct superclasses

<c-c-int>.

Direct methods

• m-a-exp.
• m-b-exp.
• m-c-exp.

---

6.2.1 Special variables

Special Variable: *v-a-int* ¶

Documentation example for variable @b(*v-a-int*)

Package

mnas-package/example.

Source

example.lisp.

Special Variable: *v-b-int* ¶

Documentation example for variable @b(*v-a-int*)

Package

mnas-package/example.

Source

example.lisp.

Special Variable: *v-c-int* ¶

Documentation example for variable @b(*v-c-int*) ================================================================================

Package

mnas-package/example.

Source

example.lisp.

Special Variable: +mainfest-lisp-template+ ¶

@b(Описание:) переменая @b(+mainfest-lisp-template+) определяет шаблон для создания файла @i(docs/manifest.lisp).

Package

mnas-package.

Source

mnas-package.lisp.

---

6.2.2 Macros

Macro: k-a-int (a b) ¶

Documentation example for macro k-a ===================================================================

Package

mnas-package/example.

Source

example.lisp.

Macro: k-b-int (a b) ¶

Documentation example for macro k-a

Package

mnas-package/example.

Source

example.lisp.

Macro: k-c-int (a b) ¶

Documentation example for macro k-a ===================================================================

Package

mnas-package/example.

Source

example.lisp.

Macro: make-doc (obj-name obj-type doc-string) ¶

Package

mnas-package/sys.

Source

sys-doc.lisp.

Macro: make-doc (obj-name obj-type doc-string) ¶

Package

mnas-package.

Source

mnas-package-doc.lisp.

Macro: make-doc (obj-name obj-type doc-string) ¶

Package

mnas-package/sec.

Source

sec-doc.lisp.

Macro: make-doc (obj-name obj-type doc-string) ¶

Package

mnas-package/view.

Source

view-doc.lisp.

Macro: make-doc (obj-name obj-type doc-string) ¶

Package

mnas-package/make.

Source

make-doc.lisp.

Macro: make-doc (obj-name obj-type doc-string) ¶

Package

mnas-package/pkg.

Source

pkg-doc.lisp.

Macro: make-doc (obj-name obj-type doc-string) ¶

Package

mnas-package/obj.

Source

obj-doc.lisp.

---

6.2.3 Ordinary functions

Function: codex-build-pathname (system-designator) ¶

@b(Описание:) функция @b(codex-docs-pathname) возвращает строку,
содержащую расположение каталога ./docs системы @b(system-designator) на диске.

@b(Пример использования:)
@begin[lang=lisp](code)
(codex-build-pathname :mnas-package)
=> "D:/PRG/msys32/home/namatv/quicklisp/local-projects/mnas/mnas-package/docs" @end(code)

Package

mnas-package.

Source

mnas-package.lisp.

Function: codex-docs-pathname (system-designator) ¶

@b(Описание:) функция @b(codex-docs-pathname) возвращает строку,
содержащую расположение каталога ./docs системы @b(system-designator) на диске.

@b(Пример использования:)
@begin[lang=lisp](code)
(codex-docs-pathname :mnas-package)
=> "D:/PRG/msys32/home/namatv/quicklisp/local-projects/mnas/mnas-package/docs" @end(code)

Package

mnas-package.

Source

mnas-package.lisp.

Function: codex-html-pathname (system-designator) ¶

@b(Описание:) функция @b(codex-html-pathname) возвращает строку,
содержащую расположение каталога ./docs/build/mnas-package/html системы
@b(system-designator) на диске.

@b(Пример использования:)
@begin[lang=lisp](code)
(codex-html-pathname :mnas-package)
=> "D:/PRG/msys32/home/namatv/quicklisp/local-projects/mnas/mnas-package/docs/build/mnas-package/html" @end(code)

Package

mnas-package.

Source

mnas-package.lisp.

Function: codex-html-pathname/ (system-name) ¶

@b(Пример использования:)
@begin[lang=lisp](code)
(codex-html-pathname/ "mnas-package")
=> "/home/namatv/quicklisp/local-projects/mnas/mnas-package/docs/build/mnas-package/html/" @end(code)

NIL

Package

mnas-package.

Source

mnas-package.lisp.

Function: defu-defm-name (func) ¶

Not yet documented

Package

mnas-package/pkg.

Source

pkg.lisp.

Function: f-a-int () ¶

Documentation example for function @b(f-a-exp) ================================================================================

Package

mnas-package/example.

Source

example.lisp.

Function: f-b-int () ¶

Documentation example for function @b(f-b-exp) ================================================================================

Package

mnas-package/example.

Source

example.lisp.

Function: f-c-int () ¶

Documentation example for function @b(f-c-exp) ================================================================================

Package

mnas-package/example.

Source

example.lisp.

Function: find-all-generics (class prefix) ¶

@b(Описание:) функция @b(find-all-generics) возвращает список обобщенных функций, связанных с классом @b(class), начинающихся с префикса @b(prefix).

@b(Пример использования:)
@begin[lang=lisp](code)
(require :temperature-fild/t-fild)
(find-all-generics (find-class ’mtf/t-fild:<t-fild>) "SPLOT") @end(code)

Package

mnas-package.

Source

mnas-package.lisp.

Function: find-all-methods (class prefix) ¶

(pprint (find-all-methods (find-class ’mtf:<sector>) "SEC"))

Package

mnas-package.

Source

mnas-package.lisp.

Function: find-slot (slot-name class) ¶

Package

mnas-package/sys.

Source

sys-doc.lisp.

Function: find-slot (slot-name class) ¶

Package

mnas-package.

Source

mnas-package-doc.lisp.

Function: find-slot (slot-name class) ¶

Package

mnas-package/sec.

Source

sec-doc.lisp.

Function: find-slot (slot-name class) ¶

Package

mnas-package/view.

Source

view-doc.lisp.

Function: find-slot (slot-name class) ¶

Package

mnas-package/make.

Source

make-doc.lisp.

Function: find-slot (slot-name class) ¶

Package

mnas-package/pkg.

Source

pkg-doc.lisp.

Function: find-slot (slot-name class) ¶

Package

mnas-package/obj.

Source

obj-doc.lisp.

Function: make-codex-documentation (package-name &key stream system-name external internal inherited sort min-doc-length) ¶

@b(Описание:) функция @b(make-codex-documentation) выводит в поток @b(stream) секции с документацией в формате codex, содержащие:
@begin(list)
@item(переменные;)
@item(функции;)
@item(макросы;)
@item(setf-функции;)
@item(обобщенные функции;)
@item(методы;)
@item(классы.)
@end(list)
из пакета @b(package-name).

@b(Пример использования:)
@begin[lang=lisp](code)
(make-codex-documentation :mnas-package/example :internal t)
@end(code)

Package

mnas-package.

Source

mnas-package.lisp.

Function: mk-pathname (dir-list) ¶

Package

mnas-package.

Source

mnas-package.lisp.

Function: ordered-dep-tree (dep-tree) ¶

Not yet documented

Package

mnas-package/pkg.

Source

pkg.lisp.

Function: package-symbols-all (package-name) ¶

@b(Описание:) package-symbols-all Выполнят поиск всех символов, определенных пакетом @b(package-name).

@b(Пример использования:)
@begin[lang=lisp](code)
(package-symbols-all ’mnas-package)
(package-symbols-all :mnas-package)
(package-symbols-all (find-package :mnas-package)) (package-symbols-all "MNAS-PACKAGE")
@end(code)

Package

mnas-package/pkg.

Source

pkg.lisp.

Function: remove-msys-prefix (path) ¶

@b(Описание:) функция @b(remove-msys-prefix)

@b(Пример использования:)
@begin[lang=lisp](code)
(remove-msys-prefix "D:/home/_namatv/PRG/msys64/home/namatv/quicklisp/local-projects/mnas/mnas-package/docs/build/mnas-package/html") => "/home/namatv/quicklisp/local-projects/mnas/mnas-package/docs/build/mnas-package/html"

(remove-msys-prefix "D:/home/_namatv/PRG/msys64/home/namatv/quicklisp/local-projects/mnas/mnas-package/docs/build/mnas-package/html/") => "/home/namatv/quicklisp/local-projects/mnas/mnas-package/docs/build/mnas-package/html/"
@end(code)

Package

mnas-package.

Source

mnas-package.lisp.

Function: who-calls (func) ¶

Not yet documented

Package

mnas-package/pkg.

Source

pkg.lisp.

Function: who-references (var) ¶

Выполняет поиск функций, в которых есть ссылка на внешнюю переменную var. Возвращает список, каждым элементом которого является список следующего формата: (функция переменная).

@b(Пример использования:)
@begin[lang=lisp](code)
(who-references ’*sample-var*)
=> (("who-references" "*sample-var*"))
@end(code)

Package

mnas-package/pkg.

Source

pkg.lisp.

---

6.2.4 Generic functions

Generic Function: ->key (thing) ¶

Not yet documented

Package

mnas-package/pkg.

Source

pkg.lisp.

Methods

Method: ->key ((thing cons)) ¶

Выполнить отладку!

Method: ->key ((thing symbol)) ¶

Method: ->key ((thing string)) ¶

Generic Reader: <c-a-int>-a (object) ¶

Generic Writer: (setf <c-a-int>-a) (object) ¶

Package

mnas-package/example.

Methods

Reader Method: <c-a-int>-a ((<c-a-int> <c-a-int>)) ¶

Writer Method: (setf <c-a-int>-a) ((<c-a-int> <c-a-int>)) ¶

Slot @b(a) for something.

Source

example.lisp.

Target Slot

a.

Generic Reader: <c-b-int>-b (object) ¶

Generic Writer: (setf <c-b-int>-b) (object) ¶

Package

mnas-package/example.

Methods

Reader Method: <c-b-int>-b ((<c-b-int> <c-b-int>)) ¶

Writer Method: (setf <c-b-int>-b) ((<c-b-int> <c-b-int>)) ¶

Slot @b(b) for something.

Source

example.lisp.

Target Slot

b.

Generic Reader: <c-c-int>-c (object) ¶

Generic Writer: (setf <c-c-int>-c) (object) ¶

Package

mnas-package/example.

Methods

Reader Method: <c-c-int>-c ((<c-c-int> <c-c-int>)) ¶

Writer Method: (setf <c-c-int>-c) ((<c-c-int> <c-c-int>)) ¶

Slot @b(c) for something.

Source

example.lisp.

Target Slot

c.

Generic Function: m-a-int (x y z) ¶

Documentation example for defgeneric @b(m-a-int) ================================================================================

Package

mnas-package/example.

Source

example.lisp.

Generic Function: m-b-int (x y z) ¶

Documentation example for defgeneric @b(m-b-int) ================================================================================

Package

mnas-package/example.

Source

example.lisp.

Generic Function: m-c-int (x y z) ¶

Documentation example for defgeneric @b(m-c-int) ================================================================================

Package

mnas-package/example.

Source

example.lisp.

---

6.2.5 Classes

Class: <c-a-int> ¶

Documentation example for class <c-a-int> ====================================================================

Package

mnas-package/example.

Source

example.lisp.

Direct subclasses

• <c-a-exp>.
• <c-b-int>.

Direct methods

• (setf <c-a-int>-a).
• <c-a-int>-a.
• (setf m-a-exp).
• (setf m-a-exp).
• m-a-exp.
• (setf m-b-exp).
• (setf m-b-exp).
• m-b-exp.
• (setf m-c-exp).
• (setf m-c-exp).
• m-c-exp.
• print-object.

Direct slots

Slot: a ¶

Slot @b(a) for something.

Initargs

mnas-package/example::a

Readers

<c-a-int>-a.

Writers

(setf <c-a-int>-a).

Class: <c-b-int> ¶

Documentation example for class <c-b-int> ====================================================================

Package

mnas-package/example.

Source

example.lisp.

Direct superclasses

<c-a-int>.

Direct subclasses

<c-b-exp>.

Direct methods

• (setf <c-b-int>-b).
• <c-b-int>-b.
• (setf m-a-exp).
• (setf m-a-exp).
• m-a-exp.
• (setf m-b-exp).
• (setf m-b-exp).
• m-b-exp.
• (setf m-c-exp).
• (setf m-c-exp).
• m-c-exp.
• print-object.

Direct slots

Slot: b ¶

Slot @b(b) for something.

Initargs

mnas-package/example::b

Readers

<c-b-int>-b.

Writers

(setf <c-b-int>-b).

Class: <c-c-int> ¶

Documentation example for class <c-c-int> ====================================================================

Package

mnas-package/example.

Source

example.lisp.

Direct subclasses

<c-c-exp>.

Direct methods

• (setf <c-c-int>-c).
• <c-c-int>-c.
• m-c-exp.
• print-object.

Direct slots

Slot: c ¶

Slot @b(c) for something.

Initargs

mnas-package/example::c

Readers

<c-c-int>-c.

Writers

(setf <c-c-int>-c).

---