Skip to content

Ensure that "internal" API fields are hidden from the HTML API docs #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
1 commit merged into from
Feb 16, 2011
Merged

Ensure that "internal" API fields are hidden from the HTML API docs #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions ocaml/doc/apidoc.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down
1 change: 1 addition & 0 deletions ocaml/doc/jsapi.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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) ^ "}"
Expand Down