yard 0.8.7.6 → 0.9.0
Sign up to get free protection for your applications and to get access to all the features.
Potentially problematic release.
This version of yard might be problematic. Click here for more details.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -1
- data/LICENSE +2 -2
- data/README.md +2 -2
- data/Rakefile +1 -1
- data/bin/yard +0 -0
- data/bin/yardoc +0 -0
- data/bin/yri +0 -0
- data/docs/GettingStarted.md +88 -6
- data/docs/images/handlers-class-diagram.png +0 -0
- data/docs/images/overview-class-diagram.png +0 -0
- data/docs/images/parser-class-diagram.png +0 -0
- data/docs/templates/default/fulldoc/html/full_list_tag.erb +6 -4
- data/lib/yard/autoload.rb +3 -0
- data/lib/yard/cli/yardoc.rb +1 -1
- data/lib/yard/code_objects/base.rb +4 -1
- data/lib/yard/code_objects/extra_file_object.rb +3 -1
- data/lib/yard/code_objects/proxy.rb +2 -2
- data/lib/yard/docstring.rb +11 -6
- data/lib/yard/handlers/base.rb +1 -2
- data/lib/yard/handlers/c/base.rb +19 -0
- data/lib/yard/handlers/c/handler_methods.rb +42 -8
- data/lib/yard/handlers/c/init_handler.rb +1 -1
- data/lib/yard/handlers/c/method_handler.rb +3 -3
- data/lib/yard/handlers/ruby/decorator_handler_methods.rb +132 -0
- data/lib/yard/handlers/ruby/legacy/private_class_method_handler.rb +1 -1
- data/lib/yard/handlers/ruby/private_class_method_handler.rb +6 -39
- data/lib/yard/handlers/ruby/private_constant_handler.rb +36 -30
- data/lib/yard/handlers/ruby/public_class_method_handler.rb +13 -0
- data/lib/yard/handlers/ruby/struct_handler_methods.rb +1 -0
- data/lib/yard/handlers/ruby/visibility_handler.rb +5 -8
- data/lib/yard/logging.rb +1 -0
- data/lib/yard/parser/ruby/ruby_parser.rb +2 -2
- data/lib/yard/parser/source_parser.rb +6 -6
- data/lib/yard/rake/yardoc_task.rb +2 -2
- data/lib/yard/serializers/file_system_serializer.rb +33 -1
- data/lib/yard/server/commands/display_file_command.rb +8 -3
- data/lib/yard/server/commands/display_object_command.rb +7 -3
- data/lib/yard/server/doc_server_helper.rb +2 -8
- data/lib/yard/server/doc_server_serializer.rb +2 -4
- data/lib/yard/server/router.rb +1 -1
- data/lib/yard/server/templates/default/fulldoc/html/css/custom.css +57 -8
- data/lib/yard/server/templates/default/layout/html/breadcrumb.erb +2 -10
- data/lib/yard/server/templates/default/layout/html/script_setup.erb +1 -2
- data/lib/yard/server/templates/default/method_details/html/permalink.erb +3 -3
- data/lib/yard/server/templates/doc_server/processing/html/processing.erb +4 -4
- data/lib/yard/tags/directives.rb +1 -0
- data/lib/yard/tags/library.rb +9 -7
- data/lib/yard/tags/overload_tag.rb +4 -1
- data/lib/yard/templates/helpers/html_helper.rb +4 -3
- data/lib/yard/templates/template_options.rb +3 -0
- data/lib/yard/version.rb +1 -1
- data/spec/cli/command_parser_spec.rb +14 -14
- data/spec/cli/command_spec.rb +11 -11
- data/spec/cli/config_spec.rb +32 -32
- data/spec/cli/diff_spec.rb +86 -90
- data/spec/cli/display_spec.rb +6 -6
- data/spec/cli/gems_spec.rb +28 -28
- data/spec/cli/graph_spec.rb +8 -8
- data/spec/cli/help_spec.rb +8 -8
- data/spec/cli/i18n_spec.rb +33 -37
- data/spec/cli/list_spec.rb +2 -2
- data/spec/cli/markup_types_spec.rb +3 -3
- data/spec/cli/server_spec.rb +74 -88
- data/spec/cli/stats_spec.rb +14 -14
- data/spec/cli/yardoc_spec.rb +316 -321
- data/spec/cli/yri_spec.rb +45 -45
- data/spec/code_objects/base_spec.rb +174 -173
- data/spec/code_objects/class_object_spec.rb +65 -65
- data/spec/code_objects/code_object_list_spec.rb +13 -11
- data/spec/code_objects/constants_spec.rb +68 -58
- data/spec/code_objects/extra_file_object_spec.rb +71 -59
- data/spec/code_objects/macro_object_spec.rb +64 -64
- data/spec/code_objects/method_object_spec.rb +80 -72
- data/spec/code_objects/module_object_spec.rb +47 -47
- data/spec/code_objects/namespace_object_spec.rb +51 -51
- data/spec/code_objects/proxy_spec.rb +54 -54
- data/spec/config_spec.rb +104 -104
- data/spec/core_ext/array_spec.rb +5 -5
- data/spec/core_ext/file_spec.rb +33 -33
- data/spec/core_ext/hash_spec.rb +5 -5
- data/spec/core_ext/insertion_spec.rb +18 -18
- data/spec/core_ext/module_spec.rb +6 -6
- data/spec/core_ext/string_spec.rb +17 -17
- data/spec/core_ext/symbol_hash_spec.rb +42 -39
- data/spec/docstring_parser_spec.rb +65 -65
- data/spec/docstring_spec.rb +137 -130
- data/spec/handlers/alias_handler_spec.rb +39 -39
- data/spec/handlers/attribute_handler_spec.rb +35 -35
- data/spec/handlers/base_spec.rb +60 -51
- data/spec/handlers/c/alias_handler_spec.rb +6 -6
- data/spec/handlers/c/attribute_handler_spec.rb +12 -12
- data/spec/handlers/c/class_handler_spec.rb +35 -22
- data/spec/handlers/c/constant_handler_spec.rb +24 -22
- data/spec/handlers/c/init_handler_spec.rb +10 -10
- data/spec/handlers/c/method_handler_spec.rb +150 -65
- data/spec/handlers/c/mixin_handler_spec.rb +5 -5
- data/spec/handlers/c/module_handler_spec.rb +27 -15
- data/spec/handlers/c/override_comment_handler_spec.rb +14 -14
- data/spec/handlers/c/path_handler_spec.rb +8 -8
- data/spec/handlers/c/spec_helper.rb +10 -0
- data/spec/handlers/c/struct_handler_spec.rb +3 -3
- data/spec/handlers/class_condition_handler_spec.rb +18 -18
- data/spec/handlers/class_handler_spec.rb +97 -97
- data/spec/handlers/class_method_handler_shared_examples.rb +132 -0
- data/spec/handlers/class_variable_handler_spec.rb +3 -3
- data/spec/handlers/constant_handler_spec.rb +32 -29
- data/spec/handlers/decorator_handler_methods_spec.rb +405 -0
- data/spec/handlers/dsl_handler_spec.rb +108 -109
- data/spec/handlers/examples/constant_handler_001.rb.txt +4 -1
- data/spec/handlers/examples/visibility_handler_001.rb.txt +4 -0
- data/spec/handlers/exception_handler_spec.rb +23 -23
- data/spec/handlers/extend_handler_spec.rb +9 -9
- data/spec/handlers/legacy_base_spec.rb +60 -60
- data/spec/handlers/method_condition_handler_spec.rb +5 -5
- data/spec/handlers/method_handler_spec.rb +92 -92
- data/spec/handlers/mixin_handler_spec.rb +25 -25
- data/spec/handlers/module_function_handler_spec.rb +24 -24
- data/spec/handlers/module_handler_spec.rb +15 -15
- data/spec/handlers/private_class_method_handler_spec.rb +4 -48
- data/spec/handlers/private_constant_handler_spec.rb +8 -8
- data/spec/handlers/processor_spec.rb +12 -12
- data/spec/handlers/public_class_method_handler_spec.rb +10 -0
- data/spec/handlers/ruby/base_spec.rb +16 -16
- data/spec/handlers/ruby/legacy/base_spec.rb +20 -18
- data/spec/handlers/spec_helper.rb +1 -1
- data/spec/handlers/visibility_handler_spec.rb +25 -21
- data/spec/handlers/yield_handler_spec.rb +28 -28
- data/spec/i18n/locale_spec.rb +16 -16
- data/spec/i18n/message_spec.rb +8 -8
- data/spec/i18n/messages_spec.rb +14 -14
- data/spec/i18n/pot_generator_spec.rb +32 -32
- data/spec/i18n/text_spec.rb +22 -22
- data/spec/logging_spec.rb +12 -12
- data/spec/options_spec.rb +56 -56
- data/spec/parser/base_spec.rb +9 -9
- data/spec/parser/c_parser_spec.rb +50 -50
- data/spec/parser/ruby/ast_node_spec.rb +7 -7
- data/spec/parser/ruby/legacy/statement_list_spec.rb +106 -106
- data/spec/parser/ruby/legacy/token_list_spec.rb +27 -27
- data/spec/parser/ruby/ruby_parser_spec.rb +123 -113
- data/spec/parser/source_parser_spec.rb +224 -224
- data/spec/parser/tag_parsing_spec.rb +6 -7
- data/spec/rake/yardoc_task_spec.rb +38 -48
- data/spec/registry_spec.rb +143 -143
- data/spec/registry_store_spec.rb +165 -165
- data/spec/rubygems/doc_manager_spec.rb +38 -38
- data/spec/serializers/file_system_serializer_spec.rb +53 -33
- data/spec/serializers/yardoc_serializer_spec.rb +15 -15
- data/spec/server/adapter_spec.rb +15 -15
- data/spec/server/commands/base_spec.rb +29 -29
- data/spec/server/commands/library_command_spec.rb +12 -12
- data/spec/server/commands/static_file_command_spec.rb +28 -28
- data/spec/server/doc_server_helper_spec.rb +8 -8
- data/spec/server/doc_server_serializer_spec.rb +23 -18
- data/spec/server/rack_adapter_spec.rb +6 -6
- data/spec/server/router_spec.rb +39 -39
- data/spec/server/static_caching_spec.rb +16 -16
- data/spec/server/webrick_servlet_spec.rb +6 -7
- data/spec/server_spec.rb +3 -3
- data/spec/spec_helper.rb +11 -2
- data/spec/tags/default_factory_spec.rb +64 -64
- data/spec/tags/default_tag_spec.rb +5 -5
- data/spec/tags/directives_spec.rb +121 -121
- data/spec/tags/library_spec.rb +14 -14
- data/spec/tags/overload_tag_spec.rb +24 -24
- data/spec/tags/ref_tag_list_spec.rb +12 -12
- data/spec/templates/class_spec.rb +3 -3
- data/spec/templates/constant_spec.rb +4 -4
- data/spec/templates/engine_spec.rb +47 -48
- data/spec/templates/examples/class001.html +129 -101
- data/spec/templates/examples/class002.html +31 -27
- data/spec/templates/examples/method001.html +54 -47
- data/spec/templates/examples/method002.html +33 -28
- data/spec/templates/examples/method003.html +70 -64
- data/spec/templates/examples/method004.html +13 -9
- data/spec/templates/examples/method005.html +38 -32
- data/spec/templates/examples/module001.html +343 -339
- data/spec/templates/examples/module002.html +147 -124
- data/spec/templates/examples/module003.html +94 -81
- data/spec/templates/examples/module004.html +40 -33
- data/spec/templates/helpers/base_helper_spec.rb +91 -95
- data/spec/templates/helpers/html_helper_spec.rb +276 -279
- data/spec/templates/helpers/html_syntax_highlight_helper_spec.rb +16 -15
- data/spec/templates/helpers/markup/rdoc_markup_spec.rb +27 -34
- data/spec/templates/helpers/markup_helper_spec.rb +57 -57
- data/spec/templates/helpers/method_helper_spec.rb +20 -20
- data/spec/templates/helpers/shared_signature_examples.rb +33 -31
- data/spec/templates/helpers/text_helper_spec.rb +6 -6
- data/spec/templates/method_spec.rb +7 -7
- data/spec/templates/module_spec.rb +7 -7
- data/spec/templates/onefile_spec.rb +7 -7
- data/spec/templates/section_spec.rb +66 -69
- data/spec/templates/spec_helper.rb +1 -1
- data/spec/templates/tag_spec.rb +5 -5
- data/spec/templates/template_spec.rb +158 -158
- data/spec/verifier_spec.rb +52 -52
- data/templates/default/fulldoc/html/css/full_list.css +32 -31
- data/templates/default/fulldoc/html/css/style.css +212 -77
- data/templates/default/fulldoc/html/frames.erb +6 -15
- data/templates/default/fulldoc/html/full_list.erb +14 -21
- data/templates/default/fulldoc/html/full_list_class.erb +1 -1
- data/templates/default/fulldoc/html/full_list_file.erb +6 -4
- data/templates/default/fulldoc/html/full_list_method.erb +8 -6
- data/templates/default/fulldoc/html/js/app.js +100 -76
- data/templates/default/fulldoc/html/js/full_list.js +170 -135
- data/templates/default/fulldoc/html/setup.rb +50 -7
- data/templates/default/layout/html/breadcrumb.erb +0 -2
- data/templates/default/layout/html/headers.erb +2 -1
- data/templates/default/layout/html/layout.erb +16 -10
- data/templates/default/layout/html/script_setup.erb +1 -2
- data/templates/default/layout/html/search.erb +7 -2
- data/templates/default/layout/html/setup.rb +16 -0
- data/templates/default/method/html/header.erb +7 -6
- data/templates/default/module/html/attribute_summary.erb +1 -1
- data/templates/default/module/html/box_info.erb +24 -18
- data/templates/default/module/html/constant_summary.erb +9 -11
- data/templates/default/module/html/item_summary.erb +1 -1
- data/templates/default/module/html/method_summary.erb +1 -1
- data/templates/guide/fulldoc/html/setup.rb +1 -1
- data/yard.gemspec +1 -2
- metadata +10 -7
- data/spec/handlers/examples/private_class_method_handler_001.rb.txt +0 -9
- data/spec/handlers/examples/private_class_method_handler_002.rb.txt +0 -18
- data/spec/handlers/examples/private_class_method_handler_003.rb.txt +0 -11
|
@@ -1,26 +1,17 @@
|
|
|
1
|
-
<!DOCTYPE html
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
5
3
|
<head>
|
|
6
|
-
|
|
4
|
+
<meta charset="<%= charset %>">
|
|
7
5
|
<title><%= options.title %></title>
|
|
8
6
|
</head>
|
|
9
7
|
<script type="text/javascript" charset="utf-8">
|
|
10
|
-
window.onload = function() {
|
|
11
8
|
var match = unescape(window.location.hash).match(/^#!(.+)/);
|
|
12
9
|
var name = match ? match[1] : '<%= url_for_main %>';
|
|
13
10
|
name = name.replace(/^(\w+):\/\//, '').replace(/^\/\//, '');
|
|
14
|
-
|
|
15
|
-
'<frame name="list" src="<%= url_for_list('class') %>" />' +
|
|
16
|
-
'<frame name="main" src="' + escape(name) + '" />' +
|
|
17
|
-
'</frameset>');
|
|
18
|
-
}
|
|
11
|
+
window.top.location = name;
|
|
19
12
|
</script>
|
|
20
13
|
<noscript>
|
|
21
|
-
<
|
|
22
|
-
|
|
23
|
-
<frame name="main" src="<%= url_for_main %>" />
|
|
24
|
-
</frameset>
|
|
14
|
+
<h1>Oops!</h1>
|
|
15
|
+
<h2>YARD requires JavaScript!</h2>
|
|
25
16
|
</noscript>
|
|
26
17
|
</html>
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
<!DOCTYPE html
|
|
2
|
-
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
1
|
+
<!DOCTYPE html>
|
|
3
2
|
<html>
|
|
4
3
|
<head>
|
|
5
|
-
<meta
|
|
4
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
5
|
+
<meta charset="<%= charset %>" />
|
|
6
6
|
<% stylesheets_full_list.each do |stylesheet| %>
|
|
7
7
|
<link rel="stylesheet" href="<%= url_for(stylesheet) %>" type="text/css" media="screen" charset="utf-8" />
|
|
8
8
|
<% end %>
|
|
@@ -15,26 +15,19 @@
|
|
|
15
15
|
<base id="base_target" target="_parent" />
|
|
16
16
|
</head>
|
|
17
17
|
<body>
|
|
18
|
-
<script type="text/javascript" charset="utf-8">
|
|
19
|
-
var hasFrames = false;
|
|
20
|
-
try {
|
|
21
|
-
hasFrames = window.top.frames.main ? true : false;
|
|
22
|
-
} catch (e) { }
|
|
23
|
-
if (hasFrames) {
|
|
24
|
-
document.getElementById('base_target').target = 'main';
|
|
25
|
-
document.body.className = 'frames';
|
|
26
|
-
}
|
|
27
|
-
</script>
|
|
28
18
|
<div id="content">
|
|
29
|
-
<
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
<%= list[:
|
|
34
|
-
|
|
35
|
-
|
|
19
|
+
<div class="fixed_header">
|
|
20
|
+
<h1 id="full_list_header"><%= @list_title %></h1>
|
|
21
|
+
<div id="full_list_nav">
|
|
22
|
+
<% menu_lists.each do |list| %>
|
|
23
|
+
<span><a target="_self" href="<%= url_for_list list[:type] %>">
|
|
24
|
+
<%= list[:title] %>
|
|
25
|
+
</a></span>
|
|
26
|
+
<% end %>
|
|
27
|
+
</div>
|
|
28
|
+
|
|
29
|
+
<div id="search">Search: <input type="text" /></div>
|
|
36
30
|
</div>
|
|
37
|
-
<div id="search">Search: <input type="text" /></div>
|
|
38
31
|
|
|
39
32
|
<ul id="full_list" class="<%= @list_class || @list_type %>">
|
|
40
33
|
<%= erb "full_list_#{@list_type}" %>
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
<li><%= link_object(Registry.root, Registry.root.title, nil, false) %></li>
|
|
1
|
+
<li id="object_" class="odd"><div class="item" style="padding-left:30px"><%= link_object(Registry.root, Registry.root.title, nil, false) %></div></li>
|
|
2
2
|
<%= class_list %>
|
|
@@ -1,5 +1,7 @@
|
|
|
1
|
-
<%
|
|
1
|
+
<% even_odd = 'odd' %>
|
|
2
2
|
<% @items.each do |item| %>
|
|
3
|
-
<li
|
|
4
|
-
|
|
5
|
-
|
|
3
|
+
<li id="object_<%= item.path %>" class="<%= even_odd %>">
|
|
4
|
+
<div class="item"><span class="object_link"><%= link_file item %></span></div>
|
|
5
|
+
</li>
|
|
6
|
+
<% even_odd = (even_odd == 'even' ? 'odd' : 'even') %>
|
|
7
|
+
<% end %>
|
|
@@ -1,8 +1,10 @@
|
|
|
1
|
-
<%
|
|
1
|
+
<% even_odd = 'odd' %>
|
|
2
2
|
<% @items.each do |item| %>
|
|
3
|
-
<li class="
|
|
4
|
-
|
|
5
|
-
|
|
3
|
+
<li class="<%= even_odd %> <%= item.has_tag?(:deprecated) ? 'deprecated' : '' %>">
|
|
4
|
+
<div class="item">
|
|
5
|
+
<%= linkify item, h(item.name(true)) %>
|
|
6
|
+
<small><%= item.namespace.title %></small>
|
|
7
|
+
</div>
|
|
6
8
|
</li>
|
|
7
|
-
<%
|
|
8
|
-
<% end %>
|
|
9
|
+
<% even_odd = (even_odd == 'even' ? 'odd' : 'even') %>
|
|
10
|
+
<% end %>
|
|
@@ -1,3 +1,9 @@
|
|
|
1
|
+
(function() {
|
|
2
|
+
|
|
3
|
+
var localStorage = {}, sessionStorage = {};
|
|
4
|
+
try { localStorage = window.localStorage; } catch (e) { }
|
|
5
|
+
try { sessionStorage = window.sessionStorage; } catch (e) { }
|
|
6
|
+
|
|
1
7
|
function createSourceLinks() {
|
|
2
8
|
$('.method_details_list .source_code').
|
|
3
9
|
before("<span class='showSource'>[<a href='#' class='toggleSource'>View source</a>]</span>");
|
|
@@ -16,7 +22,7 @@ function createDefineLinks() {
|
|
|
16
22
|
$('.defines').after(" <a href='#' class='toggleDefines'>more...</a>");
|
|
17
23
|
$('.toggleDefines').toggle(function() {
|
|
18
24
|
tHeight = $(this).parent().prev().height();
|
|
19
|
-
$(this).prev().
|
|
25
|
+
$(this).prev().css('display', 'inline');
|
|
20
26
|
$(this).parent().prev().height($(this).parent().height());
|
|
21
27
|
$(this).text("(less)");
|
|
22
28
|
},
|
|
@@ -42,29 +48,39 @@ function createFullTreeLinks() {
|
|
|
42
48
|
});
|
|
43
49
|
}
|
|
44
50
|
|
|
45
|
-
function
|
|
46
|
-
$('dl.box dd.r1, dl.box dd.r2').each(function() {
|
|
47
|
-
$(this).prev().height($(this).height());
|
|
48
|
-
});
|
|
49
|
-
}
|
|
50
|
-
|
|
51
|
-
function searchFrameLinks() {
|
|
51
|
+
function searchFrameButtons() {
|
|
52
52
|
$('.full_list_link').click(function() {
|
|
53
53
|
toggleSearchFrame(this, $(this).attr('href'));
|
|
54
54
|
return false;
|
|
55
55
|
});
|
|
56
|
+
window.addEventListener('message', function(e) {
|
|
57
|
+
if (e.data === 'navEscape') {
|
|
58
|
+
$('#search_frame').slideUp(100);
|
|
59
|
+
$('#search a').removeClass('active inactive');
|
|
60
|
+
$(window).focus();
|
|
61
|
+
}
|
|
62
|
+
});
|
|
63
|
+
|
|
64
|
+
$(window).resize(function() {
|
|
65
|
+
if ($('#search:visible').length === 0) {
|
|
66
|
+
$('#search_frame').slideUp(100);
|
|
67
|
+
$('#search a').removeClass('active inactive');
|
|
68
|
+
$(window).focus();
|
|
69
|
+
}
|
|
70
|
+
});
|
|
56
71
|
}
|
|
57
72
|
|
|
58
73
|
function toggleSearchFrame(id, link) {
|
|
59
74
|
var frame = $('#search_frame');
|
|
60
75
|
$('#search a').removeClass('active').addClass('inactive');
|
|
61
|
-
if (frame.attr('src')
|
|
76
|
+
if (frame.attr('src') === link && frame.css('display') !== "none") {
|
|
62
77
|
frame.slideUp(100);
|
|
63
78
|
$('#search a').removeClass('active inactive');
|
|
64
79
|
}
|
|
65
80
|
else {
|
|
66
81
|
$(id).addClass('active').removeClass('inactive');
|
|
67
|
-
frame.attr('src'
|
|
82
|
+
if (frame.attr('src') !== link) frame.attr('src', link);
|
|
83
|
+
frame.slideDown(100);
|
|
68
84
|
}
|
|
69
85
|
}
|
|
70
86
|
|
|
@@ -74,43 +90,10 @@ function linkSummaries() {
|
|
|
74
90
|
});
|
|
75
91
|
}
|
|
76
92
|
|
|
77
|
-
function framesInit() {
|
|
78
|
-
if (hasFrames) {
|
|
79
|
-
document.body.className = 'frames';
|
|
80
|
-
$('#menu .noframes a').attr('href', document.location);
|
|
81
|
-
try {
|
|
82
|
-
window.top.document.title = $('html head title').text();
|
|
83
|
-
} catch(error) {
|
|
84
|
-
// some browsers will not allow this when serving from file://
|
|
85
|
-
// but we don't want to stop the world.
|
|
86
|
-
}
|
|
87
|
-
}
|
|
88
|
-
else {
|
|
89
|
-
$('#menu .noframes a').text('frames').attr('href', framesUrl);
|
|
90
|
-
}
|
|
91
|
-
}
|
|
92
|
-
|
|
93
|
-
function keyboardShortcuts() {
|
|
94
|
-
if (window.top.frames.main) return;
|
|
95
|
-
$(document).keypress(function(evt) {
|
|
96
|
-
if (evt.altKey || evt.ctrlKey || evt.metaKey || evt.shiftKey) return;
|
|
97
|
-
if (typeof evt.target !== "undefined" &&
|
|
98
|
-
(evt.target.nodeName == "INPUT" ||
|
|
99
|
-
evt.target.nodeName == "TEXTAREA")) return;
|
|
100
|
-
switch (evt.charCode) {
|
|
101
|
-
case 67: case 99: $('#class_list_link').click(); break; // 'c'
|
|
102
|
-
case 77: case 109: $('#method_list_link').click(); break; // 'm'
|
|
103
|
-
case 70: case 102: $('#file_list_link').click(); break; // 'f'
|
|
104
|
-
default: break;
|
|
105
|
-
}
|
|
106
|
-
});
|
|
107
|
-
}
|
|
108
|
-
|
|
109
93
|
function summaryToggle() {
|
|
110
|
-
$('.summary_toggle').click(function() {
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
}
|
|
94
|
+
$('.summary_toggle').click(function(e) {
|
|
95
|
+
e.preventDefault();
|
|
96
|
+
localStorage.summaryCollapsed = $(this).text();
|
|
114
97
|
$('.summary_toggle').each(function() {
|
|
115
98
|
$(this).text($(this).text() == "collapse" ? "expand" : "collapse");
|
|
116
99
|
var next = $(this).parent().parent().nextAll('ul.summary').first();
|
|
@@ -132,18 +115,9 @@ function summaryToggle() {
|
|
|
132
115
|
});
|
|
133
116
|
return false;
|
|
134
117
|
});
|
|
135
|
-
if (localStorage) {
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
}
|
|
139
|
-
else localStorage.summaryCollapsed = "expand";
|
|
140
|
-
}
|
|
141
|
-
}
|
|
142
|
-
|
|
143
|
-
function fixOutsideWorldLinks() {
|
|
144
|
-
$('a').each(function() {
|
|
145
|
-
if (window.location.host != this.host) this.target = '_parent';
|
|
146
|
-
});
|
|
118
|
+
if (localStorage.summaryCollapsed == "collapse") {
|
|
119
|
+
$('.summary_toggle').first().click();
|
|
120
|
+
} else { localStorage.summaryCollapsed = "expand"; }
|
|
147
121
|
}
|
|
148
122
|
|
|
149
123
|
function generateTOC() {
|
|
@@ -185,7 +159,7 @@ function generateTOC() {
|
|
|
185
159
|
lastTag = thisTag;
|
|
186
160
|
});
|
|
187
161
|
if (!show) return;
|
|
188
|
-
html = '<div id="toc"><p class="title"><a
|
|
162
|
+
html = '<div id="toc"><p class="title hide_toc"><a href="#"><strong>Table of Contents</strong></a></p></div>';
|
|
189
163
|
$('#content').prepend(html);
|
|
190
164
|
$('#toc').append(_toc);
|
|
191
165
|
$('#toc .hide_toc').toggle(function() {
|
|
@@ -197,23 +171,73 @@ function generateTOC() {
|
|
|
197
171
|
$('#toc').toggleClass('hidden');
|
|
198
172
|
$('#toc .title small').toggle();
|
|
199
173
|
});
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
174
|
+
}
|
|
175
|
+
|
|
176
|
+
function navResizeFn(e) {
|
|
177
|
+
if (e.which !== 1) {
|
|
178
|
+
navResizeFnStop();
|
|
179
|
+
return;
|
|
180
|
+
}
|
|
181
|
+
|
|
182
|
+
sessionStorage.navWidth = e.pageX.toString();
|
|
183
|
+
$('.nav_wrap').css('width', e.pageX);
|
|
184
|
+
$('.nav_wrap').css('-ms-flex', 'inherit');
|
|
185
|
+
}
|
|
186
|
+
|
|
187
|
+
function navResizeFnStop() {
|
|
188
|
+
$(window).unbind('mousemove', navResizeFn);
|
|
189
|
+
window.removeEventListener('message', navMessageFn, false);
|
|
190
|
+
}
|
|
191
|
+
|
|
192
|
+
function navMessageFn(e) {
|
|
193
|
+
if (e.data.action === 'mousemove') navResizeFn(e.data.event);
|
|
194
|
+
if (e.data.action === 'mouseup') navResizeFnStop();
|
|
195
|
+
}
|
|
196
|
+
|
|
197
|
+
function navResizer() {
|
|
198
|
+
$('#resizer').mousedown(function(e) {
|
|
199
|
+
e.preventDefault();
|
|
200
|
+
$(window).mousemove(navResizeFn);
|
|
201
|
+
window.addEventListener('message', navMessageFn, false);
|
|
206
202
|
});
|
|
203
|
+
$(window).mouseup(navResizeFnStop);
|
|
204
|
+
|
|
205
|
+
if (sessionStorage.navWidth) {
|
|
206
|
+
navResizeFn({which: 1, pageX: parseInt(sessionStorage.navWidth, 10)});
|
|
207
|
+
}
|
|
207
208
|
}
|
|
208
209
|
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
210
|
+
function navExpander() {
|
|
211
|
+
var done = false, timer = setTimeout(postMessage, 500);
|
|
212
|
+
function postMessage() {
|
|
213
|
+
if (done) return;
|
|
214
|
+
clearTimeout(timer);
|
|
215
|
+
var opts = { action: 'expand', path: pathId };
|
|
216
|
+
document.getElementById('nav').contentWindow.postMessage(opts, '*');
|
|
217
|
+
done = true;
|
|
218
|
+
}
|
|
219
|
+
|
|
220
|
+
window.addEventListener('message', function(event) {
|
|
221
|
+
if (event.data === 'navReady') postMessage();
|
|
222
|
+
return false;
|
|
223
|
+
}, false);
|
|
224
|
+
}
|
|
225
|
+
|
|
226
|
+
function mainFocus() {
|
|
227
|
+
$('#main')[0].focus();
|
|
228
|
+
}
|
|
229
|
+
|
|
230
|
+
$(document).ready(function() {
|
|
231
|
+
navResizer();
|
|
232
|
+
navExpander();
|
|
233
|
+
createSourceLinks();
|
|
234
|
+
createDefineLinks();
|
|
235
|
+
createFullTreeLinks();
|
|
236
|
+
searchFrameButtons();
|
|
237
|
+
linkSummaries();
|
|
238
|
+
summaryToggle();
|
|
239
|
+
generateTOC();
|
|
240
|
+
mainFocus();
|
|
241
|
+
});
|
|
242
|
+
|
|
243
|
+
})();
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
1
|
+
(function() {
|
|
2
|
+
|
|
3
|
+
var $clicked = $(null);
|
|
4
|
+
var searchTimeout = null;
|
|
3
5
|
var searchCache = [];
|
|
4
|
-
var searchString = '';
|
|
5
|
-
var regexSearchString = '';
|
|
6
6
|
var caseSensitiveMatch = false;
|
|
7
7
|
var ignoreKeyCodeMin = 8;
|
|
8
8
|
var ignoreKeyCodeMax = 46;
|
|
@@ -12,170 +12,205 @@ RegExp.escape = function(text) {
|
|
|
12
12
|
return text.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, "\\$&");
|
|
13
13
|
}
|
|
14
14
|
|
|
15
|
-
function
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
if (link.length === 0) return;
|
|
21
|
-
var fullName = link.attr('title').split(' ')[0];
|
|
22
|
-
searchCache.push({name:link.text(), fullName:fullName, node:$(this), link:link});
|
|
15
|
+
function escapeShortcut() {
|
|
16
|
+
$(document).keydown(function(evt) {
|
|
17
|
+
if (evt.which == 27) {
|
|
18
|
+
window.parent.postMessage('navEscape', '*');
|
|
19
|
+
}
|
|
23
20
|
});
|
|
21
|
+
}
|
|
24
22
|
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
23
|
+
function navResizer() {
|
|
24
|
+
$(window).mousemove(function(e) {
|
|
25
|
+
window.parent.postMessage({
|
|
26
|
+
action: 'mousemove', event: {pageX: e.pageX, which: e.which}
|
|
27
|
+
}, '*');
|
|
28
|
+
}).mouseup(function(e) {
|
|
29
|
+
window.parent.postMessage({action: 'mouseup'}, '*');
|
|
30
|
+
});
|
|
31
|
+
window.parent.postMessage("navReady", "*");
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
function clearSearchTimeout() {
|
|
35
|
+
clearTimeout(searchTimeout);
|
|
36
|
+
searchTimeout = null;
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
function enableLinks() {
|
|
40
|
+
// load the target page in the parent window
|
|
41
|
+
$('#full_list li').on('click', function(evt) {
|
|
42
|
+
$('#full_list li').removeClass('clicked');
|
|
43
|
+
$clicked = $(this);
|
|
44
|
+
$clicked.addClass('clicked');
|
|
45
|
+
evt.stopPropagation();
|
|
46
|
+
|
|
47
|
+
if (evt.target.tagName === 'A') return true;
|
|
48
|
+
|
|
49
|
+
var elem = $clicked.find('> .item .object_link a')[0];
|
|
50
|
+
var e = evt.originalEvent;
|
|
51
|
+
var newEvent = new MouseEvent(evt.originalEvent.type);
|
|
52
|
+
newEvent.initMouseEvent(e.type, e.canBubble, e.cancelable, e.view, e.detail, e.screenX, e.screenY, e.clientX, e.clientY, e.ctrlKey, e.altKey, e.shiftKey, e.metaKey, e.button, e.relatedTarget);
|
|
53
|
+
elem.dispatchEvent(newEvent);
|
|
54
|
+
evt.preventDefault();
|
|
55
|
+
return false;
|
|
56
|
+
});
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
function enableToggles() {
|
|
60
|
+
// show/hide nested classes on toggle click
|
|
61
|
+
$('#full_list a.toggle').on('click', function(evt) {
|
|
62
|
+
evt.stopPropagation();
|
|
63
|
+
evt.preventDefault();
|
|
64
|
+
$(this).parent().parent().toggleClass('collapsed');
|
|
65
|
+
highlight();
|
|
66
|
+
});
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
function populateSearchCache() {
|
|
70
|
+
$('#full_list li .item').each(function() {
|
|
71
|
+
var $node = $(this);
|
|
72
|
+
var $link = $node.find('.object_link a');
|
|
73
|
+
if ($link.length > 0) {
|
|
74
|
+
searchCache.push({
|
|
75
|
+
node: $node,
|
|
76
|
+
link: $link,
|
|
77
|
+
name: $link.text(),
|
|
78
|
+
fullName: $link.attr('title').split(' ')[0]
|
|
46
79
|
});
|
|
47
|
-
if (clicked) {
|
|
48
|
-
clicked.parents('ul').each(function() {
|
|
49
|
-
$(this).removeClass('collapsed').prev().removeClass('collapsed');
|
|
50
|
-
});
|
|
51
|
-
}
|
|
52
|
-
highlight();
|
|
53
80
|
}
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
81
|
+
});
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
function enableSearch() {
|
|
85
|
+
$('#search input').keyup(function(event) {
|
|
86
|
+
if (ignoredKeyPress(event)) return;
|
|
87
|
+
if (this.value === "") {
|
|
88
|
+
clearSearch();
|
|
89
|
+
} else {
|
|
90
|
+
performSearch(this.value);
|
|
61
91
|
}
|
|
62
92
|
});
|
|
63
93
|
|
|
64
|
-
$('#
|
|
65
|
-
|
|
94
|
+
$('#full_list').after("<div id='noresults' style='display:none'></div>");
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
function ignoredKeyPress(event) {
|
|
98
|
+
if (
|
|
99
|
+
(event.keyCode > ignoreKeyCodeMin && event.keyCode < ignoreKeyCodeMax) ||
|
|
100
|
+
(event.keyCode == commandKey)
|
|
101
|
+
) {
|
|
102
|
+
return true;
|
|
103
|
+
} else {
|
|
104
|
+
return false;
|
|
105
|
+
}
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
function clearSearch() {
|
|
109
|
+
clearSearchTimeout();
|
|
110
|
+
$('#full_list .found').removeClass('found').each(function() {
|
|
111
|
+
var $link = $(this).find('.object_link a');
|
|
112
|
+
$link.text($link.text());
|
|
113
|
+
});
|
|
114
|
+
$('#full_list, #content').removeClass('insearch');
|
|
115
|
+
$clicked.parents().removeClass('collapsed');
|
|
116
|
+
highlight();
|
|
117
|
+
}
|
|
118
|
+
|
|
119
|
+
function performSearch(searchString) {
|
|
120
|
+
clearSearchTimeout();
|
|
121
|
+
$('#full_list, #content').addClass('insearch');
|
|
122
|
+
$('#noresults').text('').hide();
|
|
123
|
+
partialSearch(searchString, 0);
|
|
66
124
|
}
|
|
67
125
|
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
126
|
+
function partialSearch(searchString, offset) {
|
|
127
|
+
var lastRowClass = '';
|
|
128
|
+
var i = null;
|
|
129
|
+
for (i = offset; i < Math.min(offset + 50, searchCache.length); i++) {
|
|
130
|
+
var item = searchCache[i];
|
|
72
131
|
var searchName = (searchString.indexOf('::') != -1 ? item.fullName : item.name);
|
|
73
|
-
var matchString =
|
|
132
|
+
var matchString = buildMatchString(searchString);
|
|
74
133
|
var matchRegexp = new RegExp(matchString, caseSensitiveMatch ? "" : "i");
|
|
75
134
|
if (searchName.match(matchRegexp) == null) {
|
|
76
135
|
item.node.removeClass('found');
|
|
136
|
+
item.link.text(item.link.text());
|
|
77
137
|
}
|
|
78
138
|
else {
|
|
79
|
-
item.node.
|
|
80
|
-
item.node.parents().addClass('search_uncollapsed');
|
|
139
|
+
item.node.addClass('found');
|
|
81
140
|
item.node.removeClass(lastRowClass).addClass(lastRowClass == 'r1' ? 'r2' : 'r1');
|
|
82
141
|
lastRowClass = item.node.hasClass('r1') ? 'r1' : 'r2';
|
|
83
142
|
item.link.html(item.name.replace(matchRegexp, "<strong>$&</strong>"));
|
|
84
143
|
}
|
|
85
|
-
|
|
86
|
-
if (searchCache.length === searchIndex + 1) {
|
|
87
|
-
searchDone();
|
|
88
|
-
return;
|
|
89
|
-
}
|
|
90
|
-
else {
|
|
91
|
-
searchIndex++;
|
|
92
|
-
}
|
|
93
144
|
}
|
|
94
|
-
|
|
145
|
+
if(i == searchCache.length) {
|
|
146
|
+
searchDone();
|
|
147
|
+
} else {
|
|
148
|
+
searchTimeout = setTimeout(function() {
|
|
149
|
+
partialSearch(searchString, i);
|
|
150
|
+
}, 0);
|
|
151
|
+
}
|
|
95
152
|
}
|
|
96
153
|
|
|
97
154
|
function searchDone() {
|
|
98
|
-
|
|
155
|
+
searchTimeout = null;
|
|
156
|
+
highlight();
|
|
99
157
|
if ($('#full_list li:visible').size() === 0) {
|
|
100
158
|
$('#noresults').text('No results were found.').hide().fadeIn();
|
|
101
|
-
}
|
|
102
|
-
|
|
103
|
-
$('#noresults').text('');
|
|
159
|
+
} else {
|
|
160
|
+
$('#noresults').text('').hide();
|
|
104
161
|
}
|
|
105
162
|
$('#content').removeClass('insearch');
|
|
106
|
-
clearTimeout(inSearch);
|
|
107
|
-
inSearch = null;
|
|
108
|
-
}
|
|
109
|
-
|
|
110
|
-
clicked = null;
|
|
111
|
-
function linkList() {
|
|
112
|
-
$('#full_list li, #full_list li a:last').click(function(evt) {
|
|
113
|
-
if ($(this).hasClass('toggle')) return true;
|
|
114
|
-
if (this.tagName.toLowerCase() == "li") {
|
|
115
|
-
if ($(this).find('.object_link a').length === 0) {
|
|
116
|
-
$(this).children('a.toggle').click();
|
|
117
|
-
return false;
|
|
118
|
-
}
|
|
119
|
-
var toggle = $(this).children('a.toggle');
|
|
120
|
-
if (toggle.size() > 0 && evt.pageX < toggle.offset().left) {
|
|
121
|
-
toggle.click();
|
|
122
|
-
return false;
|
|
123
|
-
}
|
|
124
|
-
}
|
|
125
|
-
if (clicked) clicked.removeClass('clicked');
|
|
126
|
-
var win;
|
|
127
|
-
try {
|
|
128
|
-
win = window.top.frames.main ? window.top.frames.main : window.parent;
|
|
129
|
-
} catch (e) { win = window.parent; }
|
|
130
|
-
if (this.tagName.toLowerCase() == "a") {
|
|
131
|
-
clicked = $(this).parents('li').addClass('clicked');
|
|
132
|
-
win.location = this.href;
|
|
133
|
-
}
|
|
134
|
-
else {
|
|
135
|
-
clicked = $(this).addClass('clicked');
|
|
136
|
-
win.location = $(this).find('a:last').attr('href');
|
|
137
|
-
}
|
|
138
|
-
return false;
|
|
139
|
-
});
|
|
140
163
|
}
|
|
141
164
|
|
|
142
|
-
function
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
});
|
|
152
|
-
$('#full_list.class').children().removeClass('collapsed');
|
|
153
|
-
highlight();
|
|
165
|
+
function buildMatchString(searchString, event) {
|
|
166
|
+
caseSensitiveMatch = searchString.match(/[A-Z]/) != null;
|
|
167
|
+
var regexSearchString = RegExp.escape(searchString);
|
|
168
|
+
if (caseSensitiveMatch) {
|
|
169
|
+
regexSearchString += "|" +
|
|
170
|
+
$.map(searchString.split(''), function(e) { return RegExp.escape(e); }).
|
|
171
|
+
join('.+?');
|
|
172
|
+
}
|
|
173
|
+
return regexSearchString;
|
|
154
174
|
}
|
|
155
175
|
|
|
156
|
-
function highlight(
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
var next = n == 1 ? 2 : 1;
|
|
160
|
-
$(this).removeClass("r" + next).addClass("r" + n);
|
|
161
|
-
if (!no_padding && $('#full_list').hasClass('class')) {
|
|
162
|
-
$(this).css('padding-left', (10 + $(this).parents('ul').size() * 15) + 'px');
|
|
163
|
-
}
|
|
164
|
-
n = next;
|
|
176
|
+
function highlight() {
|
|
177
|
+
$('#full_list li:visible').each(function(n) {
|
|
178
|
+
$(this).removeClass('even odd').addClass(n % 2 == 0 ? 'odd' : 'even');
|
|
165
179
|
});
|
|
166
180
|
}
|
|
167
181
|
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
182
|
+
/**
|
|
183
|
+
* Expands the tree to the target element and its immediate
|
|
184
|
+
* children.
|
|
185
|
+
*/
|
|
186
|
+
function expandTo(path) {
|
|
187
|
+
var $target = $(document.getElementById('object_' + path));
|
|
188
|
+
$target.addClass('clicked');
|
|
189
|
+
$target.removeClass('collapsed');
|
|
190
|
+
$target.parentsUntil('#full_list', 'li').removeClass('collapsed');
|
|
191
|
+
if($target[0]) {
|
|
192
|
+
window.scrollTo(window.scrollX, $target.offset().top - 250);
|
|
193
|
+
highlight();
|
|
194
|
+
}
|
|
195
|
+
}
|
|
196
|
+
|
|
197
|
+
function windowEvents(event) {
|
|
198
|
+
var msg = event.data;
|
|
199
|
+
if (msg.action === "expand") {
|
|
200
|
+
expandTo(msg.path);
|
|
201
|
+
}
|
|
202
|
+
return false;
|
|
176
203
|
}
|
|
177
204
|
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
$(
|
|
181
|
-
|
|
205
|
+
window.addEventListener("message", windowEvents, false);
|
|
206
|
+
|
|
207
|
+
$(document).ready(function() {
|
|
208
|
+
escapeShortcut();
|
|
209
|
+
navResizer();
|
|
210
|
+
enableLinks();
|
|
211
|
+
enableToggles();
|
|
212
|
+
populateSearchCache();
|
|
213
|
+
enableSearch();
|
|
214
|
+
});
|
|
215
|
+
|
|
216
|
+
})();
|