Пакет mnas-package/docs содержит функции генерирования секций документации.
Переменные
*min-doc-length*
Функции
section-classes
(package-name &key (stream t) (external t) (internal nil) (inherited nil) (sort t) (min-doc-length *min-doc-length*) &aux (package (find-package package-name)))
Описание: функция section-classes выводит в поток stream секцию с документацией в формате codex, содержащую классы из пакета package-name.
Пример использования:
(require :dxf)
(section-classes :dxf :internal t)
section-functions
(package-name &key (stream t) (external t) (internal nil) (inherited nil) (sort t) (min-doc-length *min-doc-length*) &aux (package (find-package package-name)))
Описание: функция section-functions выводит в поток stream секцию с документацией в формате codex, содержащую функции из пакета package-name.
Пример использования:
(section-functions :math/stat :external t :internal t :sort t)
section-generics
(package-name &key (stream t) (external t) (internal nil) (inherited nil) (sort t) (min-doc-length *min-doc-length*) &aux (package (find-package package-name)))
Описание: функция section-generics выводит в поток stream секцию с документацией в формате codex, содержащую обобщенные функции из пакета package-name.
Пример использования:
(section-generics :mnas-package/example :internal t :sort t)
section-macroses
(package-name &key (stream t) (external t) (internal nil) (inherited nil) (sort t) (min-doc-length *min-doc-length*) &aux (package (find-package package-name)))
Описание: функция section-functions выводит в поток stream секцию с документацией в формате codex, содержащую функции из пакета package-name.
Пример использования:
(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)
section-methods
(package-name &key (stream t) (external t) (internal nil) (inherited nil) (sort nil) (min-doc-length *min-doc-length*) &aux (package (find-package package-name)))
Описание: функция section-methods выводит в поток stream секцию с документацией в формате codex, содержащую методы из пакета package-name.
Пример использования:
(section-methods :mnas-package/example :internal t)
section-setf-functions
(package-name &key (stream t) (external t) (internal nil) (inherited nil) (sort t) (min-doc-length *min-doc-length*) &aux (package (find-package package-name)))
Описание: функция section-setf-functions выводит в поток stream секцию с документацией в формате codex, содержащую setf-функции из пакета package-name.
Пример использования:
(section-setf-functions :mnas-package/example :external t :internal t :sort t)
(section-setf-functions :mnas-package/example :external t :internal t :sort nil)
section-setf-generics
(package-name &key (stream t) (external t) (internal nil) (inherited nil) (sort t) (min-doc-length *min-doc-length*) &aux (package (find-package package-name)))
Описание: функция section-setf-generics выводит в поток stream секцию с документацией в формате codex, содержащую обощенные setf-функции из пакета package-name.
Пример использования:
(section-setf-generics :mnas-package/example :external t :internal t :sort nil)
(section-setf-generics :mnas-package/example :external t :internal t :sort t)
section-setf-methods
(package-name &key (stream t) (external t) (internal nil) (inherited nil) (sort nil) (min-doc-length *min-doc-length*) &aux (package (find-package package-name)))
Описание: функция section-setf-methods выводит в поток stream секцию с документацией в формате codex, содержащую setf-методы из пакета package-name.
Пример использования:
(section-setf-methods :mnas-package/example :internal t :sort nil)
section-variables
(package-name &key (stream t) (external t) (internal nil) (inherited nil) (sort t) (min-doc-length *min-doc-length*) &aux (package (find-package package-name)))
Описание: функция section-classes выводит в поток stream секцию с документацией в формате codex, содержащую переменные из пакета package-name.
Пример использования:
(require :dxf)
(section-classes :dxf :internal t)
Обобщенные функции
insert-codex-doc
(obj &key stream min-doc-length)
Описание: обобщенная функция make-codex-doc выводит в поток stream код для вставки документации, относящейся к объекту obj. Документация объекта выводится в поток только если ее длина превышает min-doc-length.
Возвращает:
- t - если документация была выведена в поток;
- nil - если документация не была выведена в поток.
Методы
insert-codex-doc
((symbol symbol) &key (stream t) (min-doc-length *min-doc-length*))
(mapcar #'insert-codex-doc (mpkg/pkg:package-variables :mnas-package/example :internal t))
insert-codex-doc
((package package) &key (stream t) (min-doc-length *min-doc-length*))
(insert-codex-doc (find-package :mpkg))