Commits

Anonymous committed 9357cbc

geninfo: add function comment

Add comment explaining data structures used by function derive_data.

  • Participants
  • Parent commits 6ecbede

Comments (0)

Files changed (1)

 }
 
 
+#
+# derive_data(contentdata, funcdata, bbdata)
+#
+# Calculate function coverage data by combining line coverage data and the
+# list of lines belonging to a function.
+#
+# contentdata: [ instr1, count1, source1, instr2, count2, source2, ... ]
+# instr<n>: Instrumentation flag for line n
+# count<n>: Execution count for line n
+# source<n>: Source code for line n
+#
+# funcdata: [ count1, func1, count2, func2, ... ]
+# count<n>: Execution count for function number n
+# func<n>: Function name for function number n
+#
+# bbdata: function_name -> [ line1, line2, ... ]
+# line<n>: Line number belonging to the corresponding function
+#
+
 sub derive_data($$$)
 {
 	my ($contentdata, $funcdata, $bbdata) = @_;