branch master updated: Improve comments in tp/Texinfo/Config.pm

[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 14f21c732a Improve comments in tp/Texinfo/Config.pm
14f21c732a is described below

commit 14f21c732a766b07ce78c75a99c7d3273c5f6633
Author: Patrice Dumas <pertusus@free.fr>
AuthorDate: Sat Jul 30 17:26:53 2022 +0200

    Improve comments in tp/Texinfo/Config.pm
---
 tp/Texinfo/Config.pm | 20 ++++++++++++++------
 1 file changed, 14 insertions(+), 6 deletions(-)

diff --git a/tp/Texinfo/Config.pm b/tp/Texinfo/Config.pm
index 32b23f1afa..afe4dd81f2 100644
--- a/tp/Texinfo/Config.pm
+++ b/tp/Texinfo/Config.pm
@@ -22,9 +22,10 @@
 # be called by user init files codes are prefixed by texinfo_.
 # Functions prefixed by _GNUT_ are private.
 #
-# This package is documented in the customization_api Texinfo manual.  The
-# public functions defined here cannot and should not be documented separately
-# from the texinfo main program and HTML modules documentation.
+# This package is documented in the customization_api Texinfo manual.  This
+# package is integrated with the Texinfo main program and the Texinfo
+# HTML converter, such that it does not make sense to document the
+# public interface separately.
 
 package Texinfo::Config;
 
@@ -251,9 +252,15 @@ sub texinfo_remove_from_option_list($$)
   return 1;
 }
 
-# This also could get and set some @-command results.
-# FIXME But it does not take into account what happens during conversion,
-# for that something like $converter->get_conf(...) has to be used.
+# This function can be used to get main program variables
+# customization values.
+# For conversion customization variables, converter methods
+# should be used instead, the implementation usually used being
+# from Texinfo::Convert::Converter.
+# It is possible to set up an interface similar to those used in
+# converters for the main program configuration with the
+# Texinfo::MainConfig below, but it should not be accessed/used
+# in user defined code (and is therefore undocumented).
 sub texinfo_get_conf($)
 {
   my $var = shift;
@@ -568,6 +575,7 @@ sub GNUT_get_types_formatting_info()
   return { %$GNUT_types_formatting_info };
 }
 
+
 #####################################################################
 # the objective of this small package is to be in another
 # scope than init files and setup blessed objects that can call