protogen: comments.

diff --git a/scripts/protocol b/scripts/protocol
index c3eb6f3636e874dbf8061fb90f639a2fe3093f28..6bf9126076a72533486797c03b54df0ff0f4fa8e 100755 (executable)
--- a/scripts/protocol
+++ b/scripts/protocol
@@ -43,6 +43,9 @@ use strict;
 our @h = ();
 our @c = ();
 
 our @h = ();
 our @c = ();
 

+# Write(PATH, LINES)
+#
+# Write array ref LINES to file PATH.

 sub Write {
     my $path = shift;
     my $lines = shift;
 sub Write {
     my $path = shift;
     my $lines = shift;


@@ -55,6 +58,10 @@ sub Write {
 
 # Command classes -------------------------------------------------------------
 
 
 # Command classes -------------------------------------------------------------
 

+# c_in_decl([TYPE, NAME])
+#
+# Return the C declaration for an input parameter of type TYPE with
+# name NAME.

 sub c_in_decl {
     my $arg = shift;
 
 sub c_in_decl {
     my $arg = shift;
 


@@ -72,6 +79,10 @@ sub c_in_decl {
     }
 }
 
     }
 }
 

+# c_out_decl([TYPE, NAME])
+#
+# Return the C declaration for an output (reference) parameter of type
+# TYPE with name NAME.

 sub c_out_decl {
     my $arg = shift;
 
 sub c_out_decl {
     my $arg = shift;
 


@@ -98,6 +109,9 @@ sub c_out_decl {
     }
 }
 
     }
 }
 

+# c_param_docs([TYPE, NAME})
+#
+# Return the doc string for a C input parameter.

 sub c_param_docs {
     my $args = shift;
     my @d = ();
 sub c_param_docs {
     my $args = shift;
     my @d = ();


@@ -113,6 +127,9 @@ sub c_param_docs {
     return @d;
 }
 
     return @d;
 }
 

+# c_param_docs([TYPE, NAME})
+#
+# Return the doc string for a C output parameter.

 sub c_return_docs {
     my $return = shift;
     return () unless defined $return;
 sub c_return_docs {
     my $return = shift;
     return () unless defined $return;