From 44bfa49ac8aeeee1d147620e5d3884b2907398f0 Mon Sep 17 00:00:00 2001 From: Rob Hoes Date: Wed, 16 Feb 2011 13:17:59 +0000 Subject: [PATCH] Hide internal API-fields from HTML documentation Signed-off-by: Rob Hoes --- ocaml/doc/apidoc.js | 1 + ocaml/doc/jsapi.ml | 1 + 2 files changed, 2 insertions(+) diff --git a/ocaml/doc/apidoc.js b/ocaml/doc/apidoc.js index d111b9de956..78b935ce5e4 100644 --- a/ocaml/doc/apidoc.js +++ b/ocaml/doc/apidoc.js @@ -219,6 +219,7 @@ function class_doc() }, [], contents); fields = map(function(f){return f[1];}, fields); + fields = filter(function(f){return f.internal_only == false;}, fields); fields.sort(function(a, b){return compare(a.full_name.join('_').toLowerCase(), b.full_name.join('_').toLowerCase());}); messages = clsdoc.messages; messages = filter(function(m){return m.msg_hide_from_docs == false;}, messages); diff --git a/ocaml/doc/jsapi.ml b/ocaml/doc/jsapi.ml index 07a4bdf12e3..439a695f790 100644 --- a/ocaml/doc/jsapi.ml +++ b/ocaml/doc/jsapi.ml @@ -57,6 +57,7 @@ let _ = ) [] contents in let fields = flatten_contents obj.contents in + let fields = List.filter (fun f -> not f.internal_only) fields in let field_changes : changes_t = List.fold_left (fun l f -> l @ (changes_for_field f)) [] fields in "{'cls': '" ^ obj.name ^ "', 'obj_changes': " ^ Jsonrpc.to_string (rpc_of_changes_t obj_changes) ^ ", 'field_changes': " ^ Jsonrpc.to_string (rpc_of_changes_t field_changes) ^ ", 'msg_changes': " ^ Jsonrpc.to_string (rpc_of_changes_t msg_changes) ^ "}"