From cd86ac50198d1d5f3e3fe25aeacda9e8ed353c47 Mon Sep 17 00:00:00 2001 From: Marius Gerbershagen Date: Tue, 23 Oct 2018 21:14:50 +0200 Subject: [PATCH] doc: use category name for @defvar --- src/doc/new-doc/developer-guide/contributing-documentation.txi | 2 +- src/doc/new-doc/extensions/ffi_dffi.txi | 2 +- src/doc/new-doc/extensions/ffi_uffi.txi | 2 +- src/doc/new-doc/extensions/mp_ref_process.txi | 2 +- src/doc/new-doc/standards/data_and_control_flow.txi | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/src/doc/new-doc/developer-guide/contributing-documentation.txi b/src/doc/new-doc/developer-guide/contributing-documentation.txi index 817e09849..0048ae25c 100644 --- a/src/doc/new-doc/developer-guide/contributing-documentation.txi +++ b/src/doc/new-doc/developer-guide/contributing-documentation.txi @@ -116,7 +116,7 @@ description @defvrx {Constant} MOST_POSITIVE_FIXNUM These constants mark the limits of a fixnum. @end defvr -@defvr {FFI} *use-dffi* +@defvr Variable {ffi:*use-dffi*} Description. @end defvr @end verbatim diff --git a/src/doc/new-doc/extensions/ffi_dffi.txi b/src/doc/new-doc/extensions/ffi_dffi.txi index c865c6193..048d9ac32 100644 --- a/src/doc/new-doc/extensions/ffi_dffi.txi +++ b/src/doc/new-doc/extensions/ffi_dffi.txi @@ -3,7 +3,7 @@ @cindex Dynamic foreign function interface @lspindex ffi:*use-dffi* -@defvr {FFI} {*use-dffi*} +@defvr Variable {ffi:*use-dffi*} This variable controls whether @code{DFFI} is used or not. @end defvr diff --git a/src/doc/new-doc/extensions/ffi_uffi.txi b/src/doc/new-doc/extensions/ffi_uffi.txi index c8cf3a1c1..4b9da731a 100644 --- a/src/doc/new-doc/extensions/ffi_uffi.txi +++ b/src/doc/new-doc/extensions/ffi_uffi.txi @@ -676,7 +676,7 @@ The boolean flag. @end defun @lspindex ffi:+null-cstring-pointer+ -@defvr {FFI} {+null-cstring-pointer+} +@defvr Variable {ffi:+null-cstring-pointer+} A NULL cstring pointer. This can be used for testing if a cstring returned by a function is NULL. @end defvr diff --git a/src/doc/new-doc/extensions/mp_ref_process.txi b/src/doc/new-doc/extensions/mp_ref_process.txi index abba6cf35..7b1f1437c 100644 --- a/src/doc/new-doc/extensions/mp_ref_process.txi +++ b/src/doc/new-doc/extensions/mp_ref_process.txi @@ -275,7 +275,7 @@ Example: @deftypefun cl_object mp_current_process () @end deftypefun -@defvr {mp} {*current-process*} +@defvr Variable {mp:*current-process*} Returns/holds the current process of a caller. @end defvr diff --git a/src/doc/new-doc/standards/data_and_control_flow.txi b/src/doc/new-doc/standards/data_and_control_flow.txi index a1184c71c..b789ecd4a 100644 --- a/src/doc/new-doc/standards/data_and_control_flow.txi +++ b/src/doc/new-doc/standards/data_and_control_flow.txi @@ -114,7 +114,7 @@ defined functions, you should issue @code{(setq si:*keep-definitions* t)} at the beginning of your session. @lspindex si:*keep-definitions* -@defvr {SI} {*keep-definitions*} +@defvr Variable {si:*keep-definitions*} If set to @code{T} ECL will preserve the compiled function source code for disassembly and recompilation. @end defvr