[Xen-API] [PATCH 5 of 5] HTML code docs: Handle @param ocamldoc option

[Rob Hoes <rob.hoes@xxxxxxxxxx>]

 ocaml/doc/ocamldoc.js |  3 ++-
 1 files changed, 2 insertions(+), 1 deletions(-)


# HG changeset patch
# User Rob Hoes <rob.hoes@xxxxxxxxxx>
# Date 1276866462 -3600
# Node ID 015b4252619caec4015707e49a9629b32ed53f23
# Parent  e03e6837ff40e9b249aca50e36237339b3864438
HTML code docs: Handle @param ocamldoc option

This option can be used to attached ocamldoc comments to function parameters.

Signed-off-by: Rob Hoes <rob.hoes@xxxxxxxxxx>

diff -r e03e6837ff40 -r 015b4252619c ocaml/doc/ocamldoc.js
--- a/ocaml/doc/ocamldoc.js
+++ b/ocaml/doc/ocamldoc.js
@@ -157,7 +157,8 @@
                n = v.params[c].name;
                html += '<tr><td width="20%" style="padding: 0 0 .2em">' +
                        (n == "" ? '(no name)' : v.params[c].name) + '</td>';
-               html += '<td style="padding: 0 0 .2em">' + 
transform_type(v.params[c].type) + '</td></tr>';
+               html += '<td style="padding: 0 0 .2em">' + 
transform_type(v.params[c].type) + '</td>';
+               html += '<td style="padding: 0 0 .2em">' + (v.params[c].comment 
!= undefined ? v.params[c].comment : '') + '</td></tr>';
        }
        html += '</table>';
        html += '</td></tr>';   

_______________________________________________
xen-api mailing list
xen-api@xxxxxxxxxxxxxxxxxxx
http://lists.xensource.com/mailman/listinfo/xen-api