This is the mnas-package Reference Manual, version 0.48.54, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 17:22:00 2024 GMT+0.
mnas-package/mnas-package.asdmnas-package/src/mnas-package.lispmnas-package/src/mnas-package-doc.lispmnas-package/obj/src/obj/obj.lispmnas-package/obj/src/obj/obj-doc.lispmnas-package/pkg/src/pkg/pkg.lispmnas-package/pkg/src/pkg/pkg-doc.lispmnas-package/sys/src/sys/sys.lispmnas-package/sys/src/sys/sys-doc.lispmnas-package/make/src/make/make.lispmnas-package/make/src/make/make-doc.lispmnas-package/view/src/view/view.lispmnas-package/view/src/view/view-doc.lispmnas-package/sec/src/sec/sec.lispmnas-package/sec/src/sec/sec-doc.lispmnas-package/example/src/example/example.lispThe main system appears first, followed by any subsystem dependency.
mnas-packagemnas-package/objmnas-package/pkgmnas-package/sysmnas-package/makemnas-package/viewmnas-package/secmnas-package/examplemnas-packageСистема @b(mnas-package) предназначена для подготовки
документации, извлекаемой из asdf-систем.
@begin(section) @title(Мотивация)
Система @b(Codex) является достаточно удобной для выполнения
документирования систем, написанных с использованием @b(Common
Lisp). Она позволяет получить на выходе документацию приемлемого
вида.
К недостатку сустемы @b(Codex) можно отнести то, что формирование
шаблона документации не выполняется автоматически. Указание на
включение разделов документации, относящихся к отдельным сущностям к
которым можно отнести:
@begin(list)
@item(системы;)
@item(пакеты;)
@item(классы;)
@item(функции, setf-функции;)
@item(обобщенные функции,методы, setf-методы;)
@item(макросы;) @item(и т.д., и т.п.)
@end(list) приходится формировать вручную.
Этот проект пытается устранить данный недостаток системы @b(Codex) за
счет определения функций и методов позволяющих:
@begin(list)
@item(формировать код, предназначенный для передачи в систему
@b(Codex);)
@item(формировать представление отдельных частей системы в виде
графов.)
@end(list)
@end(section)
Mykola Matvyeyev <mnasoft@gmail.com>
GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 or later
0.48.54
mnas-package/obj (system).
mnas-package/pkg (system).
mnas-package/sys (system).
mnas-package/make (system).
mnas-package/view (system).
mnas-package/sec (system).
mnas-package/example (system).
mnas-string (system).
inferior-shell (system).
src (module).
mnas-package/objСодержит некоторые функции и обобщенные функции, используемые в проекте повсеместно
Mykola Matvyeyev <mnasoft@gmail.com>
GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 or later
closer-mop (system).
src/obj (module).
mnas-package/pkgСодержит некоторые функции и обобщенные функции, используемые в проекте повсеместно
Mykola Matvyeyev <mnasoft@gmail.com>
GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 or later
alexandria (system).
slynk (system).
mnas-package/obj (system).
src/pkg (module).
mnas-package/sysСодержит некоторые функции для извлечения иформации о системах, поределенных с помощью @b(asdf)
Mykola Matvyeyev <mnasoft@gmail.com>
GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 or later
alexandria (system).
src/sys (module).
mnas-package/makeСодержит некоторые функции и обобщенные функции, используемые в проекте повсеместно
Mykola Matvyeyev <mnasoft@gmail.com>
GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 or later
mnas-graph (system).
mnas-package/pkg (system).
src/make (module).
mnas-package/viewСодержит некоторые функции и обобщенные функции, используемые в проекте повсеместно
Mykola Matvyeyev <mnasoft@gmail.com>
GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 or later
mnas-package/make (system).
mnas-graph/view (system).
src/view (module).
mnas-package/secСодержит некоторые функции и обобщенные функции, используемые в проекте повсеместно
Mykola Matvyeyev <mnasoft@gmail.com>
GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 or later
mnas-package/obj (system).
mnas-package/pkg (system).
mnas-package/sys (system).
mnas-package/make (system).
mnas-package/view (system).
mnas-package/example (system).
mnas-string (system).
src/sec (module).
mnas-package/exampleПример системы для выполнения тестирования пакета mnas-package
Mykola Matvyeyev <mnasoft@gmail.com>
GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 or later
src/example (module).
Modules are listed depth-first from the system components tree.
mnas-package/srcmnas-package/obj/src/objmnas-package/pkg/src/pkgmnas-package/sys/src/sysmnas-package/make/src/makemnas-package/view/src/viewmnas-package/sec/src/secmnas-package/example/src/examplemnas-package/srcmnas-package (system).
mnas-package.lisp (file).
mnas-package-doc.lisp (file).
mnas-package/obj/src/objmnas-package/obj (system).
obj.lisp (file).
obj-doc.lisp (file).
mnas-package/pkg/src/pkgmnas-package/pkg (system).
pkg.lisp (file).
pkg-doc.lisp (file).
mnas-package/sys/src/sysmnas-package/sys (system).
sys.lisp (file).
sys-doc.lisp (file).
mnas-package/make/src/makemnas-package/make (system).
make.lisp (file).
make-doc.lisp (file).
mnas-package/view/src/viewmnas-package/view (system).
view.lisp (file).
view-doc.lisp (file).
mnas-package/sec/src/secmnas-package/sec (system).
sec.lisp (file).
sec-doc.lisp (file).
mnas-package/example/src/examplemnas-package/example (system).
example.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
mnas-package/mnas-package.asdmnas-package/src/mnas-package.lispmnas-package/src/mnas-package-doc.lispmnas-package/obj/src/obj/obj.lispmnas-package/obj/src/obj/obj-doc.lispmnas-package/pkg/src/pkg/pkg.lispmnas-package/pkg/src/pkg/pkg-doc.lispmnas-package/sys/src/sys/sys.lispmnas-package/sys/src/sys/sys-doc.lispmnas-package/make/src/make/make.lispmnas-package/make/src/make/make-doc.lispmnas-package/view/src/view/view.lispmnas-package/view/src/view/view-doc.lispmnas-package/sec/src/sec/sec.lispmnas-package/sec/src/sec/sec-doc.lispmnas-package/example/src/example/example.lispmnas-package/src/mnas-package.lispsrc (module).
*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).
+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).
mnas-package/src/mnas-package-doc.lispmnas-package.lisp (file).
src (module).
mnas-package/obj/src/obj/obj.lispsrc/obj (module).
obj-name (generic function).
obj-name-string (generic function).
obj-package (generic function).
obj-package-string (generic function).
mnas-package/pkg/src/pkg/pkg.lispsrc/pkg (module).
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).
->key (generic function).
defu-defm-name (function).
ordered-dep-tree (function).
package-symbols-all (function).
who-calls (function).
who-references (function).
mnas-package/pkg/src/pkg/pkg-doc.lispmnas-package/sys/src/sys/sys.lispmnas-package/sys/src/sys/sys-doc.lispmnas-package/make/src/make/make.lispsrc/make (module).
call-graph (function).
class-graph (function).
class-slot-graph (function).
generic-graph (function).
symbol-graph (function).
system-graph (function).
mnas-package/make/src/make/make-doc.lispmnas-package/view/src/view/view.lispsrc/view (module).
call-graph (function).
class-graph (function).
class-slot-graph (function).
generic-graph (function).
symbol-graph (function).
system-graph (function).
mnas-package/view/src/view/view-doc.lispmnas-package/sec/src/sec/sec.lispsrc/sec (module).
*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).
mnas-package/sec/src/sec/sec-doc.lispmnas-package/example/src/example/example.lispsrc/example (module).
*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).
*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).
Packages are listed by definition order.
mnas-package/sysmnas-packagemnas-package/secmnas-package/examplemnas-package/viewmnas-package/makemnas-package/pkgmnas-package/objmnas-package/sys@b(Описание:) Пакет @b(mnas-package/sys) предназначен для извлечения информации из asdf-систем.
mpkg/sys
common-lisp.
version (function).
mnas-package@b(Описание:) пакет @b(mnas-package) является основным в системе @b(mnas-package).
Основными функциями в системе являются:
@begin(list)
@item(document;)
@item(make-codex-graphs;)
@end(list)
Перечисленные ниже функции имеют схожий набор аргументов:
@begin(list)
@item(document;)
@item(make-codex-documentation;)
@item(section-system;)
@item(section-package;)
@item(section-variables;)
@item(section-functions;)
@item(section-macroses;)
@item(section-setf-functions;)
@item(section-generics;)
@item(section-setf-generics;)
@item(section-methods;)
@item(section-classes.)
@end(list)
@b(Аргументы:)
@begin(list)
@item(package-name - пакет из которого извлекаются
сущности (глобальными переменными, функциями, и т.д. и т.п.);)
@item(stream - поток, в который выводятся информация о сущностях;)
@item(external - если не nil - в поток выводятся информация о
экспортируемых сущностях;)
@item(internal - если не nil - в поток выводятся информация о
внутренних сущностях;)
@item(inherited - если не nil - в поток выводятся информация о
заимствованных сущностях;)
@item(sort - если не nil - сущности сортируются в алфавитном
порядке;)
@item(min-doc-length - минимальная длина строки документации,
связанной с сущностью, при которой созается ссылка указаение на
вставку документации.)
@end(list)
mpkg
common-lisp.
*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).
+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).
find-slot (function).
make-codex-documentation (function).
make-doc (macro).
mk-pathname (function).
remove-msys-prefix (function).
mnas-package/secПакет @b(mnas-package/docs) содержит функции генерирования секций документации.
mpkg/sec
common-lisp.
*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).
mnas-package/exampleDocumentation example for package @b(mnas-package/example)
Соглашения по именованию.
Имена должны начинаться с группы символов:
@begin(list)
@item("v" - для глобальных переменных;)
@item("f" - для функций;)
@item("k" - для макросов;)
@item("m" - для обобщенных функций и соответствующих им методов;)
@item("с" - классов;)
@item("s" - структур.)
@end(list)
Имена должны иметь признак, указываемый последним:
@begin(list)
@item("exp" - для экспортируемых символов;)
@item("int" - для внутрених символов.)
@end(list)
common-lisp.
*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).
*v-a-int* (special variable).
*v-b-int* (special variable).
*v-c-int* (special variable).
<c-a-int> (class).
<c-a-int>-a (generic reader).
(setf <c-a-int>-a) (generic writer).
<c-b-int> (class).
<c-b-int>-b (generic reader).
(setf <c-b-int>-b) (generic writer).
<c-c-int> (class).
<c-c-int>-c (generic reader).
(setf <c-c-int>-c) (generic writer).
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).
mnas-package/viewПакет @b(mnas-package/view) предназначен для
визуализации (сохранения в файле) графов, которые можно получить с
использованием пакета @b(mnas-package/make):
mpkg/view
common-lisp.
call-graph (function).
class-graph (function).
class-slot-graph (function).
generic-graph (function).
symbol-graph (function).
system-graph (function).
mnas-package/makeПакет @b(mnas-package/make) предназначен для создания графов следующих типов:
@begin(list)
@item(system-graph - зависимостей систем;)
@item(call-graph - вызовов функций;)
@item(symbol-graph - использования символов функциями;)
@item(class-graph - наследования классов;)
@item(class-slot-graph - слотов класса;)
@item(generic-graph - типов основных параметров обобщенных функций.)
@end(list)
mpkg/make
common-lisp.
call-graph (function).
class-graph (function).
class-slot-graph (function).
generic-graph (function).
symbol-graph (function).
system-graph (function).
mnas-package/pkgПакет @b(mnas-package/pkg) определяет операции извлечения символов по типу
их (видимости и наследования) и группировки символов по категориям, к которым
прнадлежат связанные с ними сущности.
Основными функциями пакета @b(mnas-package/pkg) являются следующие функции:
@begin(list)
@item(package-variables;)
@item(package-methods;)
@item(package-generics;)
@item(package-functions;)
@item(package-macroses;)
@item(package-setf-functions;)
@item(package-classes;)
@item(package-symbols-by-category.)
@end(list)
Все они имеют схожий набор параметров:
@begin(list)
@item(package-name - имя пакета символы которого извлекаются. Его
можно указывать в виде нескольких вариантов: ’mnas-package;
:mnas-package; "MNAS-PACKAGE". В случае указания имени
пакета как строки символы должны быть в верхнем регистре;)
@item(external - отбирать (t) или не отбирать (nil) внешиние
символы;)
@item(internal - отбирать (t) или не отбирать (nil) внутренние
символы;) @item(inherited - отбирать (t) или не отбирать (nil)
заимствованные символы.)
@end(list)
mpkg/pkg
common-lisp.
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).
->key (generic function).
defu-defm-name (function).
find-slot (function).
make-doc (macro).
ordered-dep-tree (function).
package-symbols-all (function).
who-calls (function).
who-references (function).
mnas-package/objПакет :mnas-package/obj определяет обобщенные функции и методы,
полученные на их основе для получения:
@begin(list)
@item(имени (символа), связанного с объектом;)
@item(строки, представляующей имя (символ) объекта;)
@item(пакета, в котором определен объект;)
@item(строки, представляующей пакет, в котором определен объект.)
@end(list)
mpkg/obj
common-lisp.
obj-name (generic function).
obj-name-string (generic function).
obj-package (generic function).
obj-package-string (generic function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
@b(Описание:) переменная @b(*intranet-hosts*) определяет имена хостов, на которых нет выхода в Интернет.
Устанавливает длину строки, свыше которой осуществляется вставка инструкций на генерирование документации для соответствующего объекта.
Documentation example for variable @b(*v-a-exp*) ================================================================================
Documentation example for variable @b(*v-b-exp*) ================================================================================
Documentation example for variable @b(*v-c-exp*) ================================================================================
Documentation example for macro k-a-exp ===================================================================
Documentation example for macro k-b-exp ===================================================================
Documentation example for macro k-c-exp ===================================================================
@b(Описание:) функция @b(view-call-graph) выполняет визуализацию графа вызовов
пакета @b(package-name).
@b(Пример использования:)
@begin[lang=lisp](code)
(view-call-graph :mnas-package)
@end(code)
@b(Описание:) make-call-graph возвращает граф вызовов пакета @b(package-name).
@b(Пример использования:)
@begin[lang=lisp](code)
(mnas-package:make-call-graph :mnas-package)
@end(code)
@b(Описание:) view-class-graph выводит визуальное представление
иерархии классов (графа наследования).
@b(Пример использования:)
@begin[lang=lisp](code)
(mnas-package:mnas-package-demo-11)
@end(code)
@b(Описание:) make-class-graph создает граф наследования классов.
@b(Пример использования:)
@begin[lang=lisp](code)
(make-class-graph :mnas-package )
@end(code)
@b(Описание:) функция @b(class-slot-graph) - ...
@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)
@b(Описание:) функция @b(copy-doc->public-html) выполняет копирование документации системы @b(system-name) в каталог ~/public_html/Common-Lisp-Programs.
@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)
Documentation example for function @b(f-a-exp) ================================================================================
Documentation example for function @b((setf f-b-exp)) ================================================================================
Documentation example for function @b(f-b-exp) ================================================================================
Documentation example for function @b((setf f-b-exp)) ================================================================================
Documentation example for function @b(f-c-exp) ================================================================================
Documentation example for function @b((setf f-b-exp)) ================================================================================
@b(Описание:) функция filter-functions возвращает список символов, являющихся
сопряженными с функциями.
@b(Переменые:) @begin(list) @item(symbols - список символов пакета.) @end(list)
@b(Описание:) функция @b(filter-generics) возвращает список
символов сопряженных с обобщеными функциями.
@b(Переменые:) @begin(list) @item(symbols - список символов пакета.) @end(list)
@b(Описание:) функция filter-functions возвращает список символов сопряженных
с макросами.
@b(Переменые:) @begin(list) @item(symbols - список символов пакета.) @end(list)
@b(Описание:) функция @b(filter-methods) возвращает список символов,
являющихся сопряженными с setf-методами.
@b(Переменые:)
@begin(list)
@item(symbols - список символов пакета.)
@end(list)
@b(Описание:) функция filter-functions возвращает список символов,
являющихся сопряженными с setf-функциями.
@b(Переменые:)
@begin(list)
@item(symbols - список символов пакета.)
@end(list)
@b(Описание:) функция @b(filter-setf-generics) возвращает список символов,
являющихся сопряженными с обобщенными setf-функциями.
@b(Переменые:)
@begin(list)
@item(symbols - список символов пакета.)
@end(list)
@b(Описание:) функция @b(filter-setf-methods) возвращает список символов,
являющихся сопряженными с setf-методами.
@b(Переменые:)
@begin(list)
@item(symbols - список символов пакета.)
@end(list)
@b(Описание:) функция filter-variables возвращает список символов, являющихся
сопряженными со значениями.
@b(Переменые:)
@begin(list)
@item(symbols - список символов пакета.)
@end(list)
@b(Описание:) функция @b(generic-graph) возвращает граф параметров
обобщенной функций.
Данный граф должен быть трехуровневым:
@begin(list)
@item(первый уровень - обобщенная функция;)
@item(второй - номер по порядку для обязательного параметра и его имя; )
@item(третий - тип обязательного параметра.)
@end(list)
@b(Пример использования:)
@begin[lang=lisp](code)
@end(code)
@b(Описание:) функция @b(make-codex-graphs) создает в каталоге
./docs/build/mnas-package/html gv-файлы и png-файлы, содержащие графы,
отображающие завмсимости
@begin(list)
@item(классов;)
@item(систем;)
@item(символов;)
@item(вызовов.)
@end(list)
@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">
@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)
@b(Описание:) функция @b(make-html-path) в качестве побочного
эффекта создает каталог, в который система codex выводит
html-докуметы.
@b(Пример использования:)
@begin[lang=lisp](code)
(make-html-path :mnas-path)
@end(code)
@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)
@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)
@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)
@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)
@b(Описание:) функция @b(package-functions) возвращает список макросов пакета @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)
@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)
@b(Описание:) функция @b(package-functions) возвращает список функций пакета
@b(package-name).
@b(Пример использования:) @begin[lang=lisp](code)
(package-setf-functions :mnas-package/example :internal t)
=> (#<FUNCTION (SETF MNAS-PACKAGE/EXAMPLE::FOO)>)
@end(code)
@b(Описание:) функция @b(package-functions) возвращает список функций пакета
@b(package-name).
@b(Пример использования:) @begin[lang=lisp](code)
(package-setf-functions :mnas-package/example :internal t)
=> (#<FUNCTION (SETF MNAS-PACKAGE/EXAMPLE::FOO)>)
@end(code)
@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)
@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)
@b(Описание:) функция @b(package-variables) возвращает список символов пакета
@b(package-name).
@b(Пример использования:)
@begin[lang=lisp](code)
(package-variables :mnas-package :inherited t)
@end(code)
@b(Описание:) функция @b(rsync-doc) выполняет копирование
документации на удаленный сервер.
@b(Пример использования:)
@begin[lang=lisp](code)
(rsync-doc "mnas-package")
@end(code)
@b(Описание:) функция @b(section-classes) выводит в поток @b(stream)
секцию с документацией в формате codex, содержащую классы из пакета @b(package-name).
@b(Пример использования:)
@begin[lang=lisp](code)
(require :dxf)
(section-classes :dxf :internal t)
@end(code)
@b(Описание:) функция section-functions выводит в поток stream
секцию с документацией в формате codex, содержащую функции из пакета package-name.
@b(Пример использования:)
@begin[lang=lisp](code)
(section-functions :math/stat :external t :internal t :sort t)
@end(code)
@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)
@b(Описание:) функция section-functions выводит в поток 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)
@b(Описание:) функция @b(section-methods) выводит в поток @b(stream)
секцию с документацией в формате codex, содержащую методы из пакета @b(package-name).
@b(Пример использования:)
@begin[lang=lisp](code)
(section-methods :mnas-package/example :internal t)
@end(code)
(section-package :mnas-package)
@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)
@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)
@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)
@b(Описание:) функция @b(section-classes) выводит в поток @b(stream)
секцию с документацией в формате codex, содержащую переменные из пакета @b(package-name).
@b(Пример использования:)
@begin[lang=lisp](code)
(require :dxf)
(section-classes :dxf :internal t)
@end(code)
@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)
@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)
@b(Описание:) view-symbol-graph отображает граф зависимостей глобальных символов.
Позволяет ответить на вопрос: в какой функции используется тот или иной глобальный символ.
@b(Пример использования:)
@begin[lang=lisp](code)
(view-symbol-graph :mnas-package)
@end(code)
@b(Описание:) make-symbol-graph строит граф использования методпми и функциями
внешних символов.
@b(Пример использования:)
@begin[lang=lisp](code)
(make-symbol-graph :mnas-string)
@end(code)
@b(Описание:) system-graph визуализирует граф систем, от которых зависит
система @b(system).
@b(Пример использования:)
@begin[lang=lisp](code)
(mnas-package/view:system-graph :mnas-package :out-type "png" :viewer nil)
@end(code)
@b(Описание:) make-system-graph возвращает граф систем, от которых зависит
система @b(system).
@b(Пример использования:)
@begin[lang=lisp](code)
(mnas-package:make-system-graph :mnas-package)
@end(code)
@b(Описание:) функция @b(system-version) возвращает версию системы, заданной аргументом @b(system-designator).
who-references-lst
symbol)) ¶symbol)) ¶@b(Описание:) обобщенная функция @b(make-codex-doc)
выводит в поток @b(stream) код для вставки документации, относящейся к
объекту @b(obj). Документация объекта выводится в поток только если
ее длина превышает @b(min-doc-length).
Возвращает:
@begin(list)
@item(@b(t) - если документация была выведена в поток;)
@item(@b(nil) - если документация не была выведена в поток.)
@end(list)
package) &key stream min-doc-length) ¶@b(Пример использования:) @begin[lang=lisp](code) (insert-codex-doc (find-package :mpkg)) @end(code)
method) &key stream min-doc-length) ¶(insert-codex-doc (find-package :mpkg))
class) &key stream min-doc-length) ¶standard-generic-function) &key stream min-doc-length) ¶function) &key stream min-doc-length) ¶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)
Documentation example for defgeneric @b(m-a-exp) ================================================================================
Documentation example for defgeneric @b((setf m-a-exp)) ================================================================================
<c-b-int>)) ¶Documentation example for defgeneric @b((setf m-a-exp) ((val number) (b <c-b-int>))) ================================================================================
<c-b-int>)) ¶Documentation example for defgeneric @b((setf m-a-exp) (val (b <c-b-int>))) ================================================================================
Documentation example for defgeneric @b(m-b-exp) ================================================================================
Documentation example for defgeneric @b((setf m-b-exp)) ================================================================================
<c-b-int>)) ¶Documentation example for defgeneric @b((setf m-b-exp) ((val number) (b <c-b-int>))) ================================================================================
<c-b-int>)) ¶Documentation example for defgeneric @b((setf m-b-exp) (val (b <c-b-int>))) ================================================================================
Documentation example for defgeneric @b(m-c-exp) ================================================================================
Documentation example for defgeneric @b((setf m-c-exp)) ================================================================================
<c-b-int>)) ¶Documentation example for defgeneric @b((setf m-c-exp) ((val number) (b <c-b-int>))) ================================================================================
<c-b-int>)) ¶Documentation example for defgeneric @b((setf m-c-exp) (val (b <c-b-int>))) ================================================================================
@b(Описание:) обобщенная функция @b(obj-name) возвращает символ, представляющий имя объекта obj.
slot-definition)) ¶@b(Описание:) метод @b(obj-name) возвращает символ, представляющий имя определеия слота.
package)) ¶@b(Описание:) метод @b(obj-name) возвращает символ,
представляющий имя класса.
@b(Пример использования:)
@begin[lang=lisp](code)
(obj-name (find-package :dxf))
@end(code)
class)) ¶@b(Описание:) метод @b(obj-name) возвращает символ,
представляющий имя класса.
@b(Пример использования:)
@begin[lang=lisp](code)
(obj-name (first (package-classes :dxf :internal t)))
@end(code)
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)
standard-generic-function)) ¶@b(Описание:) метод @b(obj-name) возвращает символ,
представляющий имя обобщенной функции.
Вторым значением возвращается:
@begin(list)
@item(:generic - для обыкновенной обобщенной функции;)
@item(:setf-generic - для setf обобщенной функции.)
@end(list)
function)) ¶@b(Описание:) метод @b(obj-name) возвращает символ,
представляющий имя функции.
@b(Пример использования:)
@begin[lang=lisp](code)
(obj-name (second (package-functions :mnas-package)))
@end(code)
symbol)) ¶@b(Описание:) метод @b(obj-name) возвращает символ, представляющий имя символа.
@b(Описание:) обобщенная функция @b(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)
@b(Описание:) обобщенная функция @b(obj-package) возвращает пакет, в котором определен объект obj.
slot-definition)) ¶@b(Описание:) метод @b(obj-package) возвращает символ, представляющий имя определение слота.
package)) ¶@b(Описание:) метод @b(obj-package) возвращает символ,
представляющий имя класса.
@b(Пример использования:)
@begin[lang=lisp](code)
(require :dxf)
(obj-package (find-package :dxf))
@end(code)
class)) ¶@b(Описание:) метод @b(obj-package) возвращает символ,
представляющий имя класса.
@b(Пример использования:)
@begin[lang=lisp](code)
(obj-package (first (package-classes :dxf :internal t)))
@end(code)
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)
standard-generic-function)) ¶@b(Описание:) метод @b(obj-package) возвращает символ,
представляющий имя обобщенной функции.
@b(Пример использования:)
@begin[lang=lisp](code)
(require :dxf)
(obj-package (first (package-generics :dxf)))
@end(code)
function)) ¶@b(Описание:) метод @b(obj-package) возвращает символ,
представляющий имя функции.
@b(Пример использования:)
@begin[lang=lisp](code)
(obj-package (second (package-functions :mnas-package)))
@end(code)
symbol)) ¶@b(Описание:) метод @b(obj-name) возвращает символ, представляющий имя символа.
@b(Описание:) обобщенная функция @b(obj-package-string)
возвращает строку, представляющую имя пакета, в котором определен объект @b(obj).
@b(Описание:) метод @b(obj-package-string)
возвращает строку, представляющую имя пакета, в котором определен объект @b(obj).
@b(Пример использования:)
@begin[lang=lisp](code)
(require :dxf)
(obj-package-string (find-package :dxf))
@end(code)
Documentation example for class <c-a-exp> ====================================================================
Documentation example for class <c-b-exp> ====================================================================
Documentation example for class <c-c-exp> ====================================================================
Documentation example for variable @b(*v-a-int*)
Documentation example for variable @b(*v-a-int*)
Documentation example for variable @b(*v-c-int*) ================================================================================
@b(Описание:) переменая @b(+mainfest-lisp-template+) определяет шаблон для создания файла @i(docs/manifest.lisp).
Documentation example for macro k-a ===================================================================
Documentation example for macro k-a
Documentation example for macro k-a ===================================================================
@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)
@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)
@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)
@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
Documentation example for function @b(f-a-exp) ================================================================================
Documentation example for function @b(f-b-exp) ================================================================================
Documentation example for function @b(f-c-exp) ================================================================================
@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)
(pprint (find-all-methods (find-class ’mtf:<sector>) "SEC"))
@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)
@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)
@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)
Выполняет поиск функций, в которых есть ссылка на внешнюю переменную
var. Возвращает список, каждым элементом которого является список следующего
формата: (функция переменная).
@b(Пример использования:)
@begin[lang=lisp](code)
(who-references ’*sample-var*)
=> (("who-references" "*sample-var*"))
@end(code)
Documentation example for defgeneric @b(m-a-int) ================================================================================
Documentation example for defgeneric @b(m-b-int) ================================================================================
Documentation example for defgeneric @b(m-c-int) ================================================================================
Documentation example for class <c-a-int> ====================================================================
Slot @b(a) for something.
mnas-package/example::a
Documentation example for class <c-b-int> ====================================================================
Slot @b(b) for something.
mnas-package/example::b
Documentation example for class <c-c-int> ====================================================================
Slot @b(c) for something.
mnas-package/example::c
| Jump to: | (
-
<
C D F G I K M O P R S V W |
|---|
| Jump to: | (
-
<
C D F G I K M O P R S V W |
|---|
| Jump to: | *
+
A B C S |
|---|
| Jump to: | *
+
A B C S |
|---|
| Jump to: | <
C E F M O P S V |
|---|
| Jump to: | <
C E F M O P S V |
|---|