From 9e681137deb276e00a60d8a61d9b1217487a8365 Mon Sep 17 00:00:00 2001
From: Magnus Holmgren <holmgren@lysator.liu.se>
Date: Mon, 30 May 2016 22:39:00 +0200
Subject: [PATCH] Documentation breakage
When preparing a new Debian package of 8.0.240, I noticed that some
documentation disappeared, apparently due to the following. The error
in Nettle.Sign is already corrected but not the others, AFAICT, and
I'm guessing that @exp should be @expr. Patch below, which I home
someone can apply right away.
ERROR: <Invalid error container: Tools.AutoDoc.AutoDocError(SourcePosition(File: /build/pike8.0-8.0.240/src/modules/Gmp/mpz_glue.c, lines: 668..668), "DocParser", "@exp cannot be used like this: @exp{ ... @}")>
ERROR: <Invalid error container: Tools.AutoDoc.AutoDocError(SourcePosition(File: /build/pike8.0-8.0.240/lib/modules/__builtin.pmod/Nettle.pmod/Sign.pike, lines: 102..102), "DocParser", "@item is not allowed inside @array (allowed children are: @elem)")>
ERROR: <Invalid error container: Tools.AutoDoc.AutoDocError(SourcePosition(File: /build/pike8.0-8.0.240/lib/modules/Crypto.pmod/ECC.pmod, lines: 286..286), "DocParser", "@item is not allowed inside @array (allowed children are: @elem)")>
ERROR: <Invalid error container: Tools.AutoDoc.AutoDocError(SourcePosition(File: /build/pike8.0-8.0.240/lib/modules/Crypto.pmod/RSA.pmod, lines: 368..368), "DocParser", "@item is not allowed inside @array (allowed children are: @elem)")>
---
lib/modules/Crypto.pmod/ECC.pmod | 4 ++--
lib/modules/Crypto.pmod/RSA.pmod | 4 ++--
src/modules/Gmp/mpz_glue.c | 2 +-
3 files changed, 5 insertions(+), 5 deletions(-)
diff --git a/lib/modules/Crypto.pmod/ECC.pmod b/lib/modules/Crypto.pmod/ECC.pmod
index 51b465daf7..444ca074d5 100644
--- a/lib/modules/Crypto.pmod/ECC.pmod
+++ b/lib/modules/Crypto.pmod/ECC.pmod
@@ -283,9 +283,9 @@ class Curve {
//! @returns
//! Returns @expr{0@} (zero) on failure, and an array
//! @array
- //! @item mapping(string(7bit):string(7bit)|int) 0
+ //! @elem mapping(string(7bit):string(7bit)|int) 0
//! The JOSE header.
- //! @item string(8bit) 1
+ //! @elem string(8bit) 1
//! The signed message.
//! @endarray
//!
diff --git a/lib/modules/Crypto.pmod/RSA.pmod b/lib/modules/Crypto.pmod/RSA.pmod
index 892a16c8a8..bd12dc243a 100644
--- a/lib/modules/Crypto.pmod/RSA.pmod
+++ b/lib/modules/Crypto.pmod/RSA.pmod
@@ -365,9 +365,9 @@ class State {
//! @returns
//! Returns @expr{0@} (zero) on failure, and an array
//! @array
- //! @item mapping(string(7bit):string(7bit)|int) 0
+ //! @elem mapping(string(7bit):string(7bit)|int) 0
//! The JOSE header.
- //! @item string(8bit) 1
+ //! @elem string(8bit) 1
//! The signed message.
//! @endarray
//!
diff --git a/src/modules/Gmp/mpz_glue.c b/src/modules/Gmp/mpz_glue.c
index a00b5f412f..81b79f9804 100644
--- a/src/modules/Gmp/mpz_glue.c
+++ b/src/modules/Gmp/mpz_glue.c
@@ -665,7 +665,7 @@ static void mpzmod_create(INT32 args)
/*! @decl int cast_to_int()
*! Casts the object to an integer.
*! @deprecated
- *! Use @exp{(int)@} instead.
+ *! Use @expr{(int)@} instead.
*/
static void mpzmod_get_int(INT32 args)
{
--
GitLab