branch master updated: * doc/texi2any_api.texi: minor changes.

[Patrice Dumas]

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

pertusus pushed a commit to branch master
in repository texinfo.

The following commit(s) were added to refs/heads/master by this push:
     new 1f5aad9276 * doc/texi2any_api.texi: minor changes.
1f5aad9276 is described below

commit 1f5aad9276b35627cb98a6f35052afd48a1c0475
Author: Patrice Dumas <pertusus@free.fr>
AuthorDate: Sun Mar 24 16:58:58 2024 +0100

    * doc/texi2any_api.texi: minor changes.
    
    Changes in code comments.
---
 ChangeLog                                   |  6 ++++++
 doc/generate_html_doc_texi.pl               |  8 ++++----
 doc/texi2any_api.texi                       | 21 +++++++++++----------
 tp/maintain/setup_accent_tables.pl          |  2 +-
 tp/maintain/setup_converters_code_tables.pl |  2 +-
 5 files changed, 23 insertions(+), 16 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 340653b981..2a87e0f22d 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2024-03-24  Patrice Dumas  <pertusus@free.fr>
+
+       * doc/texi2any_api.texi: minor changes.
+
+       Changes in code comments.
+
 2024-03-24  Patrice Dumas  <pertusus@free.fr>
 
        * tp/Texinfo/Convert/HTML.pm (%html_default_commands_args): rename
diff --git a/doc/generate_html_doc_texi.pl b/doc/generate_html_doc_texi.pl
index 14dc3c4041..10d97e050c 100755
--- a/doc/generate_html_doc_texi.pl
+++ b/doc/generate_html_doc_texi.pl
@@ -33,13 +33,13 @@ BEGIN
   # do not load XS code, to avoid both depending on and generating
   # XS code.  Also we do not want to have to find XS object files.
   $ENV{'TEXINFO_XS'} = 'omit';
-  # NOTE we do not use Texinfo::ModulePath as it may not have been
-  # created yet, as tp/Texinfo/XS may be processed before tp.
-  # Also we have less modules to find, only pure perl code.
+  # NOTE we do not use Texinfo::ModulePath, as we only have pure perl
+  # modules to find, we do not need something as complex, and we would
+  # need to find Texinfo::ModulePath anyway, which require similar code.
   my ($real_command_name, $command_directory, $command_suffix)
    = fileparse($0, '.pl');
   my $updir = File::Spec->updir();
-  # tp director
+  # tp directory
   my $tp_srcdir;
   if (defined($ENV{'srcdir'})) {
     # srcdir is doc/
diff --git a/doc/texi2any_api.texi b/doc/texi2any_api.texi
index d40b3793cf..f809eb6731 100644
--- a/doc/texi2any_api.texi
+++ b/doc/texi2any_api.texi
@@ -3361,7 +3361,7 @@ with text are both converted by the function reference 
registered for
 @code{text}.
 
 The definition and registration of a conversion function for all
-the tree elements holding text is along:
+the tree elements holding text should be along:
 
 @example
 sub my_convert_text($$$)
@@ -4019,8 +4019,8 @@ are used, as described in
 @caption{Association of special elements names with their special element 
variety}
 @end float
 
-The variety of special elements is in the special unit
-hash @code{special_unit_variety} key.
+The variety of special elements is the special unit
+hash value associated to the @code{special_unit_variety} key.
 
 To get information on the special output unit variety associated with
 an @@-command command name, use @code{command_name_special_unit_information}:
@@ -4455,6 +4455,7 @@ All the formatting functions take a converter object as 
first argument.
 The function reference @code{format_button} does the formatting of
 one button, corresponding, in general, to a link to a direction:
 
+@anchor{@code{format_button}}
 @deftypefn {Function Reference} @var{$formatted_button} format_button @
            (@var{$converter}, @var{$button}, @var{$source_command})
 @var{$button} holds the specification of the button (@pxref{Buttons Display}).
@@ -4549,6 +4550,7 @@ Returns a formatted icon image.
 The overall display of navigation panels is controlled via this
 function reference, @code{format_navigation_header}:
 
+@anchor{@code{format_navigation_header}}
 @deftypefn {Function Reference} @var{$navigation_text} 
format_navigation_header @
    (@var{$converter}, @var{\@@buttons}, @var{$command_name}, @var{\%element})
 @var{\@@buttons} is an array reference holding the specification of
@@ -4559,8 +4561,7 @@ the associated command (sectioning command or 
@code{@@node}).  It may be @code{u
 for special output units.
 
 Returns the formatted navigation header and panel. The navigation
-panel itself can be formatted with a
-call to @code{&@{$converter->formatting_function('format_navigation_panel')@}}.
+panel itself can be formatted with a call to @code{format_navigation_panel}.
 
 The customization variable @code{VERTICAL_HEAD_NAVIGATION} should be relevant.
 @end deftypefn
@@ -4577,7 +4578,7 @@ elements.  @var{$vertical} is true if the navigation 
panel should be vertical.
 
 Returns the formatted navigation panel in @var{$navigation_text}. The buttons
 in the navigation panel can be formatted with a call to
-@code{&@{$converter->formatting_function('format_button')@}}.
+@code{format_button} (@pxref{@code{format_button}}).
 @end deftypefn
 
 
@@ -4602,8 +4603,8 @@ Returns the formatted navigation header and panel.
 
 In the default code, the function reference select a buttons list
 (@pxref{Simple Navigation Panel Customization}).  The navigation header can
-then be formatted with a call to
-@code{&@{$converter->formatting_function('format_navigation_header')@}}.  It 
is also
+then be formatted with a call to @code{format_navigation_header}
+(@pxref{@code{format_navigation_header}}).  It is also
 possible to format directly the navigation panel, depending on customization
 variables values and location in file.
 @end deftypefn
@@ -4624,8 +4625,8 @@ Returns the formatted navigation footer and panel.
 
 In the default code, the function reference select a buttons list
 (@pxref{Simple Navigation Panel Customization}).
-The navigation header can then be formatted with a call
-to @code{&@{$converter->formatting_function('format_navigation_header')@}}.
+The navigation header can then be formatted with a call to
+@code{format_navigation_header} (@pxref{@code{format_navigation_header}}).
 
 Many customization variables have an effect on the footer
 formatting, such as @code{SPLIT}, @code{HEADERS}, @code{DEFAULT_RULE},
diff --git a/tp/maintain/setup_accent_tables.pl 
b/tp/maintain/setup_accent_tables.pl
index fc4ad7bd4e..ee426ace2b 100755
--- a/tp/maintain/setup_accent_tables.pl
+++ b/tp/maintain/setup_accent_tables.pl
@@ -32,7 +32,7 @@ BEGIN
   my ($real_command_name, $command_directory, $command_suffix)
    = fileparse($0, '.pl');
   my $updir = File::Spec->updir();
-  # tp director
+  # tp directory
   my $tp_srcdir;
   if (defined($ENV{'srcdir'})) {
     # srcdir is tp/Texinfo/XS
diff --git a/tp/maintain/setup_converters_code_tables.pl 
b/tp/maintain/setup_converters_code_tables.pl
index 974e695928..6b6c757d22 100755
--- a/tp/maintain/setup_converters_code_tables.pl
+++ b/tp/maintain/setup_converters_code_tables.pl
@@ -41,7 +41,7 @@ BEGIN
   my ($real_command_name, $command_directory, $command_suffix)
    = fileparse($0, '.pl');
   my $updir = File::Spec->updir();
-  # tp director
+  # tp directory
   my $tp_srcdir;
   if (defined($ENV{'srcdir'})) {
     # srcdir is tp/Texinfo/XS