[7475] HTML.pm add some comments

[gavinsmith0123]

Revision: 7475
          http://svn.sv.gnu.org/viewvc/?view=rev&root=texinfo&revision=7475
Author:   gavin
Date:     2016-10-29 06:05:45 +0000 (Sat, 29 Oct 2016)
Log Message:
-----------
HTML.pm add some comments

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

Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog     2016-10-29 06:02:58 UTC (rev 7474)
+++ trunk/ChangeLog     2016-10-29 06:05:45 UTC (rev 7475)
@@ -1,5 +1,10 @@
 2016-10-29  Gavin Smith  <address@hidden>
 
+       * tp/Texinfo/Convert/HTML.pm (_get_target, command_href)
+       (label_command, _node_id_file): Comments added.
+
+2016-10-29  Gavin Smith  <address@hidden>
+
        * tp/Texinfo/Convert/Plaintext.pm (_convert),
        * tp/Texinfo/Convert/HTML.pm (convert_heading_command):
        Call 'menu_of_node' with first argument undef instead of 

Modified: trunk/tp/Texinfo/Convert/HTML.pm
===================================================================
--- trunk/tp/Texinfo/Convert/HTML.pm    2016-10-29 06:02:58 UTC (rev 7474)
+++ trunk/tp/Texinfo/Convert/HTML.pm    2016-10-29 06:05:45 UTC (rev 7475)
@@ -213,6 +213,15 @@
   }
 }
 
+# $COMMAND should be a tree element which is a possible target of a link.
+#
+# Returns a hash that may have these keys set:
+# 'target': A unique string representing the target.
+# 'id': String used as argument to 'name' attribute inside <a>.
+#       Practically the same as 'target' except it can differ
+#       from 'target' depending on whether 'USE_NODE_TARGET' is true.
+# 'node_filename', 'section_filename',
+# 'misc_filename', 'filename'.  Possibly others.
 sub _get_target($$)
 {
   my $self = shift;
@@ -375,6 +384,7 @@
   return undef;
 }
 
+# Return string for linking to $COMMAND with <a href>
 sub command_href($$;$$)
 {
   my $self = shift;
@@ -570,6 +580,7 @@
   return undef;
 }
 
+# Return the element in the tree that $LABEL refers to.
 sub label_command($$)
 {
   my $self = shift;
@@ -5057,6 +5068,8 @@
   $self->{'css_rule_lines'} = address@hidden;
 }
 
+# Get the name of a file containing a node, as well as the anchor within
+# that file to link to that node.
 sub _node_id_file($$)
 {
   my $self = shift;