[7487] HTML.pm some comments

[gavinsmith0123]

Revision: 7487
          http://svn.sv.gnu.org/viewvc/?view=rev&root=texinfo&revision=7487
Author:   gavin
Date:     2016-10-31 16:12:13 +0000 (Mon, 31 Oct 2016)
Log Message:
-----------
HTML.pm some comments

Modified Paths:
--------------
    trunk/ChangeLog
    trunk/tp/Texinfo/Convert/HTML.pm

Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog     2016-10-31 11:45:17 UTC (rev 7486)
+++ trunk/ChangeLog     2016-10-31 16:12:13 UTC (rev 7487)
@@ -1,5 +1,10 @@
 2016-10-31  Gavin Smith  <address@hidden>
 
+       * tp/Texinfo/Convert/HTML.pm (_get_target, command_text)
+       (_node_id_file): Comments added or changed.
+
+2016-10-31  Gavin Smith  <address@hidden>
+
        * configure.ac (TEXINFO_DTD_VERSION): Bump version to 6.3dev.
        Although the DTD hasn't changed, the meaning has due to change
        in 'type' attribute of 'float' element on 2016-10-16.

Modified: trunk/tp/Texinfo/Convert/HTML.pm
===================================================================
--- trunk/tp/Texinfo/Convert/HTML.pm    2016-10-31 11:45:17 UTC (rev 7486)
+++ trunk/tp/Texinfo/Convert/HTML.pm    2016-10-31 16:12:13 UTC (rev 7487)
@@ -220,6 +220,8 @@
 #           'name' attribute inside <a>.
 # 'node_filename', 'section_filename',
 # 'misc_filename', 'filename'.  Possibly others.
+#
+# Some functions cache their results in these hashes.
 sub _get_target($$)
 {
   my $self = shift;
@@ -445,6 +447,13 @@
   return $href;
 }
 
+# Return text to be used for a hyperlink to $COMMAND.
+# $TYPE refers to the type of value returned from this function:
+#  'text' - return text
+#  'tree' - return a tree
+#  'tree_nonumber' - return tree representing text without a chapter number
+#                    being included.
+#  'string'
 sub command_text($$;$)
 {
   my $self = shift;
@@ -5062,7 +5071,8 @@
 }
 
 # Get the name of a file containing a node, as well as the anchor within
-# that file to link to that node.
+# that file to link to that node.  Argument is the 'extra' value on
+# an element hash, or something that looks like it.
 sub _node_id_file($$)
 {
   my $self = shift;