Mercurial > lbo > hg > ylisp
changeset 80:8ef8c191a3a1
doc: Include hand-written docs into doxygen output.
| author | Lewin Bormann <lbo@spheniscida.de> |
|---|---|
| date | Mon, 26 Aug 2019 08:40:28 +0200 |
| parents | 0a7931807163 |
| children | e5d39401bc29 |
| files | Doxyfile.in doc/execution.md doc/syntax.md doc/ylisp.md |
| diffstat | 4 files changed, 11 insertions(+), 5 deletions(-) [+] |
line wrap: on
line diff
--- a/Doxyfile.in Sun Aug 25 22:37:53 2019 +0200 +++ b/Doxyfile.in Mon Aug 26 08:40:28 2019 +0200 @@ -813,7 +813,7 @@ # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = @CMAKE_CURRENT_SOURCE_DIR@/src/ +INPUT = @CMAKE_CURRENT_SOURCE_DIR@/src/ @CMAKE_CURRENT_SOURCE_DIR@/doc/ # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
--- a/doc/execution.md Sun Aug 25 22:37:53 2019 +0200 +++ b/doc/execution.md Mon Aug 26 08:40:28 2019 +0200 @@ -1,4 +1,4 @@ -# ylisp +@page Execution ## Execution model. @@ -112,8 +112,8 @@ expects and the numeric references that it expects arguments in. Before calling, expressions are copied into those references. -Arguments are passed by value, so expressions are cloned into the argument's -slot. +Arguments are passed by value, so expressions are cloned into the arguments' +slots. The arguments are described in the `yfunc_t` struct. The return value is the value of the last expression. It is pushed onto the call stack; it will be popped from there after the function's execution.