branch master updated: @def* documentation

[Gavin D. Smith]

This is an automated email from the git hooks/post-receive script.

gavin pushed a commit to branch master
in repository texinfo.

The following commit(s) were added to refs/heads/master by this push:
     new 519c289c12 @def* documentation
519c289c12 is described below

commit 519c289c120619afd0a816a971ed3b133dd20dfb
Author: Gavin Smith <gavinsmith0123@gmail.com>
AuthorDate: Tue Aug 9 18:57:21 2022 +0100

    @def* documentation
    
    * doc/texinfo.texi (Object-Oriented Variables): Remove needless
    @code from examples.
    (Inserting an Ampersand): Mark parameter with @var.
---
 ChangeLog        |  8 ++++++++
 doc/texinfo.texi | 19 +++++++------------
 2 files changed, 15 insertions(+), 12 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 8553ff6010..7586296281 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,11 @@
+2022-08-09  Gavin Smith  <gavinsmith0123@gmail.com>
+
+       @def* documentation
+
+       * doc/texinfo.texi (Object-Oriented Variables): Remove needless
+       @code from examples.
+       (Inserting an Ampersand): Mark parameter with @var.
+
 2022-08-09  Gavin Smith  <gavinsmith0123@gmail.com>
 
        * doc/texinfo.tex (\deftypefn, \deftypeop):
diff --git a/doc/texinfo.texi b/doc/texinfo.texi
index 413e3f952a..c5b59e5b05 100644
--- a/doc/texinfo.texi
+++ b/doc/texinfo.texi
@@ -9468,14 +9468,14 @@ it's necessary to use @code{@@&} or some other 
construct.
 Here's an example:
 
 @example
-@@deftypefn Function int foo (@@code@{const std::vector<int>@@&@} bar)
+@@deftypefn Function int foo (@@code@{const std::vector<int>@@&@} @@var@{bar@})
 Documentation of @@code@{foo@}.
 @@end deftypefn
 @end example
 
 @noindent This gives the output 
 
-@deftypefn Function int foo (@code{const std::vector<int>@&} bar)
+@deftypefn Function int foo (@code{const std::vector<int>@&} @var{bar})
 Documentation of @code{foo}.
 @end deftypefn
 
@@ -12118,14 +12118,11 @@ name.  For instance:
 The @code{@@deftypecv} command is the definition command for typed
 class variables in object-oriented programming.  It is analogous to
 @code{@@defcv} with the addition of the @var{data-type} parameter to
-specify the type of the instance variable.  Ordinarily, the data type
-is a programming language construct that should be marked with
-@code{@@code}. For instance:
-@c FIXME should @code be necessary here?
+specify the type of the instance variable.
 
 @example
 @group
-@@deftypecv @{Class Option@} Window @@code@{int@} border-pattern
+@@deftypecv @{Class Option@} Window int border-pattern
 @dots{}
 @@end deftypecv
 @end group
@@ -12133,7 +12130,7 @@ is a programming language construct that should be 
marked with
 
 @noindent produces:
 
-@deftypecv {Class Option} Window @code{int} border-pattern
+@deftypecv {Class Option} Window int border-pattern
 @dots{}
 @end deftypecv
 
@@ -12167,13 +12164,11 @@ instance:
 The @code{@@deftypeivar} command is the definition command for typed
 instance variables in object-oriented programming.  It is analogous to
 @code{@@defivar} with the addition of the @var{data-type} parameter to
-specify the type of the instance variable.  Ordinarily, the data type
-is a programming language construct that should be marked with
-@code{@@code}. For instance:
+specify the type of the instance variable.
 
 @example
 @group
-@@deftypeivar Window @@code@{int@} border-pattern
+@@deftypeivar Window int border-pattern
 @dots{}
 @@end deftypeivar
 @end group