Commit 300f50ca authored by Nick Matvyeyev's avatar Nick Matvyeyev
Browse files

Some documentation added

parent 2e1ebe27
......@@ -7,6 +7,8 @@
:sources (
"mnas-string.scr"
"mnas-string-graph.scr"
"mnas-string-parse.scr"
"mnas-string-parse-graph.scr"
"mnas-string-print.scr"
"mnas-string-print-graph.scr"
"mnas-string-translit.scr"
......
@begin(section) @title(MNAS-STRING/DB)
Пакет @b(mnas-string) экспортирует следующие функции:
Пакет @b(mnas-string/db) экспортирует следующие функции:
@begin(list)
@item(@b(prepare-to-query) - подготовка строки в качестве аргумента для like запроса SQL.)
@end(list)
......
@begin(section) @title(Графы mnas-string-parse)
@begin(list)
@item(system-graph @image[src=./system-graph-mnas-string-parse.gv.png]())
@item(call-graph @image[src=./call-graph-mnas-string-parse.gv.png]())
@end(list)
@end(section)
\ No newline at end of file
@begin(section) @title(MNAS-STRING/PARSE)
Пакет @b(mnas-string) содержит в своем составе
следующие основные функции:
@begin(list)
@item(@b(read-number) - парсинг вещественного числа при
помощи считывателя Common Lisp;)
@item(@b(parse-number) - парсинг вещественного числа;)
@end(list)
@begin(section)
@title(Функции)
@cl:with-package[name="MNAS-STRING/PARSE"](
@cl:doc(function parse-number)
@cl:doc(function read-number))
@end(section)
@end(section)
......@@ -39,16 +39,16 @@
@title(Переменные)
@cl:with-package[name="MNAS-STRING/PRINT"](
@cl:doc(variable *default-month-language*)
@cl:doc(variable *mon-ua*)
@cl:doc(variable *mon-en*)
@cl:doc(variable *mon-ru*))
@cl:doc(variable *mon-ru*)
@cl:doc(variable *mon-ua*))
@end(section)
@begin(section)
@title(Функции)
@cl:with-package[name="MNAS-STRING/PRINT"](
@cl:doc(function date-time)
@cl:doc(function date)
@cl:doc(function day-time)
@cl:doc(function date-time-fname))
@cl:doc(function date-time)
@cl:doc(function date-time-fname)
@cl:doc(function day-time))
@end(section)
@end(section)
......@@ -22,8 +22,8 @@
@begin(section)
@title(Переменные)
@cl:with-package[name="MNAS-STRING/TRANSLIT"](
@cl:doc(variable *space-cir-gr->en*)
@cl:doc(variable *cir-gr->en*))
@cl:doc(variable *cir-gr->en*)
@cl:doc(variable *space-cir-gr->en*))
@end(section)
@begin(section)
@title(Функции)
......
......@@ -25,13 +25,13 @@
@begin(section)
@title(Функции)
@cl:with-package[name="MNAS-STRING"](
@cl:doc(function mpattern-to-spattern)
@cl:doc(function getenv)
@cl:doc(function make-populated-hash-table)
@cl:doc(function map-to-list)
@cl:doc(function getenv)
@cl:doc(function mpattern-to-spattern)
@cl:doc(function pre-post)
@cl:doc(function replace-all)
@cl:doc(function split)
@cl:doc(function pre-post)
@cl:doc(function trd-rename))
@end(section)
@end(section)
......@@ -92,14 +92,15 @@
:serial nil
:components ((:file "translit")))))
(defsystem "mnas-string/docs"
(defsystem "mnas-package/docs"
:description "Зависимости для сборки документации"
:author "Nick Matvyeyev <mnasoft@gmail.com>"
:license "GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 or later"
:depends-on ("mnas-string"
"codex"
;; "mnas-package"
))
:depends-on ("mnas-string" "mnas-package" "codex")
:components ((:module "src/docs"
:serial nil
:components ((:file "docs")))))
(defsystem "mnas-string/tests"
:description "Тестирование систем, входящих в проект mnas-package"
......
This diff is collapsed.
......@@ -4,7 +4,7 @@
(:use #:cl)
(:export prepare-to-query)
(:documentation
"Пакет @b(mnas-string) экспортирует следующие функции:
"Пакет @b(mnas-string/db) экспортирует следующие функции:
@begin(list)
@item(@b(prepare-to-query) - подготовка строки в качестве аргумента для like запроса SQL.)
@end(list)
......
(defpackage #:mnas-string/docs
(:use #:cl )
(:nicknames "MSTR/DOCS")
(:export make-all)
(:documentation "Пакет @b(mnas-string/docs) содержит функции
генерирования и публикации документации.
"))
(in-package :mnas-string/docs)
(defun make-document ()
(loop
:for i :in
'((:mnas-string :mnas-string)
(:mnas-string/parse nil)
(:mnas-string/print nil)
(:mnas-string/translit nil)
(:mnas-string/db nil)
)
:do (apply #'mnas-package:document i)))
(defun make-graphs ()
(loop
:for i :in
'(:mnas-string
:mnas-string/parse
:mnas-string/print
:mnas-string/translit
:mnas-string/db
)
:do (mnas-package:make-codex-graphs i i)))
(defun make-all ()
(make-document)
(make-graphs)
(codex:document :mnas-string)
(make-graphs))
;;;; (make-all)
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment