Use sdoc to generate application code documentation

This commit is contained in:
Dmitriy Zaporozhets 2012-12-30 14:43:00 +02:00
parent d075df56d3
commit 96d49bf04c
589 changed files with 75674 additions and 99966 deletions

73
doc/code/panel/index.html Executable file
View file

@ -0,0 +1,73 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<title>search index</title>
<link rel="stylesheet" href="../css/reset.css" type="text/css" media="screen" charset="utf-8" />
<link rel="stylesheet" href="../css/panel.css" type="text/css" media="screen" charset="utf-8" />
<script src="../js/search_index.js" type="text/javascript" charset="utf-8"></script>
<script src="../js/searcher.js" type="text/javascript" charset="utf-8"></script>
<script src="tree.js" type="text/javascript" charset="utf-8"></script>
<script src="../js/jquery-1.3.2.min.js" type="text/javascript" charset="utf-8"></script>
<script src="../js/searchdoc.js" type="text/javascript" charset="utf-8"></script>
<script type="text/javascript" charset="utf-8">
function placeholder() {
if ($('<input type="text">')[0].placeholder !== undefined) return;
$('#search-label').click(function() {
$('#search').focus();
$('#search-label').hide();
});
$('#search').focus(function() {
$('#search-label').hide();
});
$('#search').blur(function() {
this.value == '' && $('#search-label').show()
});
$('#search')[0].value == '' && $('#search-label').show();
}
$(function() {
placeholder();
$('#links').hide();
var panel = new Searchdoc.Panel($('#panel'), search_data, tree, window.parent.frames[1]);
$('#search').focus();
var s = window.parent.location.search.match(/\?q=([^&]+)/);
if (s) {
s = decodeURIComponent(s[1]).replace(/\+/g, ' ');
if (s.length > 0)
{
$('#search').val(s);
panel.search(s, true);
}
}
})
</script>
</head>
<body>
<div class="panel panel_tree" id="panel">
<div class="header">
<div>
<label for="search" id="search-label" style="display: none">Search</label>
<table>
<tr><td>
<input type="Search" placeholder="Search" autosave="searchdoc" results="10" id="search" autocomplete="off"/>
</td></tr>
</table></div>
</div>
<div class="tree">
<ul>
</ul>
</div>
<div class="result">
<ul>
</ul>
</div>
</div>
<a href="links.html" id="links">index</a>
</body>
</html>

314
doc/code/panel/links.html Normal file
View file

@ -0,0 +1,314 @@
<html>
<head>File index</head>
<body>
<a href="../files/app/assets/fonts/OFL_txt.html">app/assets/fonts/OFL.txt</a>
<a href="../files/app/contexts/base_context_rb.html">app/contexts/base_context.rb</a>
<a href="../files/app/contexts/commit_load_context_rb.html">app/contexts/commit_load_context.rb</a>
<a href="../files/app/contexts/issues_bulk_update_context_rb.html">app/contexts/issues_bulk_update_context.rb</a>
<a href="../files/app/contexts/issues_list_context_rb.html">app/contexts/issues_list_context.rb</a>
<a href="../files/app/contexts/merge_requests_load_context_rb.html">app/contexts/merge_requests_load_context.rb</a>
<a href="../files/app/contexts/notes/create_context_rb.html">app/contexts/notes/create_context.rb</a>
<a href="../files/app/contexts/notes/load_context_rb.html">app/contexts/notes/load_context.rb</a>
<a href="../files/app/contexts/project_update_context_rb.html">app/contexts/project_update_context.rb</a>
<a href="../files/app/contexts/search_context_rb.html">app/contexts/search_context.rb</a>
<a href="../files/app/contexts/test_hook_context_rb.html">app/contexts/test_hook_context.rb</a>
<a href="../files/app/controllers/admin/dashboard_controller_rb.html">app/controllers/admin/dashboard_controller.rb</a>
<a href="../files/app/controllers/admin/groups_controller_rb.html">app/controllers/admin/groups_controller.rb</a>
<a href="../files/app/controllers/admin/hooks_controller_rb.html">app/controllers/admin/hooks_controller.rb</a>
<a href="../files/app/controllers/admin/logs_controller_rb.html">app/controllers/admin/logs_controller.rb</a>
<a href="../files/app/controllers/admin/projects_controller_rb.html">app/controllers/admin/projects_controller.rb</a>
<a href="../files/app/controllers/admin/resque_controller_rb.html">app/controllers/admin/resque_controller.rb</a>
<a href="../files/app/controllers/admin/team_members_controller_rb.html">app/controllers/admin/team_members_controller.rb</a>
<a href="../files/app/controllers/admin/users_controller_rb.html">app/controllers/admin/users_controller.rb</a>
<a href="../files/app/controllers/admin_controller_rb.html">app/controllers/admin_controller.rb</a>
<a href="../files/app/controllers/application_controller_rb.html">app/controllers/application_controller.rb</a>
<a href="../files/app/controllers/blame_controller_rb.html">app/controllers/blame_controller.rb</a>
<a href="../files/app/controllers/blob_controller_rb.html">app/controllers/blob_controller.rb</a>
<a href="../files/app/controllers/commit_controller_rb.html">app/controllers/commit_controller.rb</a>
<a href="../files/app/controllers/commits_controller_rb.html">app/controllers/commits_controller.rb</a>
<a href="../files/app/controllers/compare_controller_rb.html">app/controllers/compare_controller.rb</a>
<a href="../files/app/controllers/dashboard_controller_rb.html">app/controllers/dashboard_controller.rb</a>
<a href="../files/app/controllers/deploy_keys_controller_rb.html">app/controllers/deploy_keys_controller.rb</a>
<a href="../files/app/controllers/errors_controller_rb.html">app/controllers/errors_controller.rb</a>
<a href="../files/app/controllers/groups_controller_rb.html">app/controllers/groups_controller.rb</a>
<a href="../files/app/controllers/help_controller_rb.html">app/controllers/help_controller.rb</a>
<a href="../files/app/controllers/hooks_controller_rb.html">app/controllers/hooks_controller.rb</a>
<a href="../files/app/controllers/issues_controller_rb.html">app/controllers/issues_controller.rb</a>
<a href="../files/app/controllers/keys_controller_rb.html">app/controllers/keys_controller.rb</a>
<a href="../files/app/controllers/labels_controller_rb.html">app/controllers/labels_controller.rb</a>
<a href="../files/app/controllers/merge_requests_controller_rb.html">app/controllers/merge_requests_controller.rb</a>
<a href="../files/app/controllers/milestones_controller_rb.html">app/controllers/milestones_controller.rb</a>
<a href="../files/app/controllers/notes_controller_rb.html">app/controllers/notes_controller.rb</a>
<a href="../files/app/controllers/omniauth_callbacks_controller_rb.html">app/controllers/omniauth_callbacks_controller.rb</a>
<a href="../files/app/controllers/profiles_controller_rb.html">app/controllers/profiles_controller.rb</a>
<a href="../files/app/controllers/project_resource_controller_rb.html">app/controllers/project_resource_controller.rb</a>
<a href="../files/app/controllers/projects_controller_rb.html">app/controllers/projects_controller.rb</a>
<a href="../files/app/controllers/protected_branches_controller_rb.html">app/controllers/protected_branches_controller.rb</a>
<a href="../files/app/controllers/refs_controller_rb.html">app/controllers/refs_controller.rb</a>
<a href="../files/app/controllers/repositories_controller_rb.html">app/controllers/repositories_controller.rb</a>
<a href="../files/app/controllers/search_controller_rb.html">app/controllers/search_controller.rb</a>
<a href="../files/app/controllers/services_controller_rb.html">app/controllers/services_controller.rb</a>
<a href="../files/app/controllers/snippets_controller_rb.html">app/controllers/snippets_controller.rb</a>
<a href="../files/app/controllers/team_members_controller_rb.html">app/controllers/team_members_controller.rb</a>
<a href="../files/app/controllers/tree_controller_rb.html">app/controllers/tree_controller.rb</a>
<a href="../files/app/controllers/wikis_controller_rb.html">app/controllers/wikis_controller.rb</a>
<a href="../files/app/decorators/application_decorator_rb.html">app/decorators/application_decorator.rb</a>
<a href="../files/app/decorators/commit_decorator_rb.html">app/decorators/commit_decorator.rb</a>
<a href="../files/app/decorators/event_decorator_rb.html">app/decorators/event_decorator.rb</a>
<a href="../files/app/decorators/tree_decorator_rb.html">app/decorators/tree_decorator.rb</a>
<a href="../files/app/decorators/user_decorator_rb.html">app/decorators/user_decorator.rb</a>
<a href="../files/app/helpers/application_helper_rb.html">app/helpers/application_helper.rb</a>
<a href="../files/app/helpers/commits_helper_rb.html">app/helpers/commits_helper.rb</a>
<a href="../files/app/helpers/dashboard_helper_rb.html">app/helpers/dashboard_helper.rb</a>
<a href="../files/app/helpers/events_helper_rb.html">app/helpers/events_helper.rb</a>
<a href="../files/app/helpers/gitlab_markdown_helper_rb.html">app/helpers/gitlab_markdown_helper.rb</a>
<a href="../files/app/helpers/issues_helper_rb.html">app/helpers/issues_helper.rb</a>
<a href="../files/app/helpers/merge_requests_helper_rb.html">app/helpers/merge_requests_helper.rb</a>
<a href="../files/app/helpers/namespaces_helper_rb.html">app/helpers/namespaces_helper.rb</a>
<a href="../files/app/helpers/notes_helper_rb.html">app/helpers/notes_helper.rb</a>
<a href="../files/app/helpers/profile_helper_rb.html">app/helpers/profile_helper.rb</a>
<a href="../files/app/helpers/projects_helper_rb.html">app/helpers/projects_helper.rb</a>
<a href="../files/app/helpers/snippets_helper_rb.html">app/helpers/snippets_helper.rb</a>
<a href="../files/app/helpers/tab_helper_rb.html">app/helpers/tab_helper.rb</a>
<a href="../files/app/helpers/tags_helper_rb.html">app/helpers/tags_helper.rb</a>
<a href="../files/app/helpers/tree_helper_rb.html">app/helpers/tree_helper.rb</a>
<a href="../files/app/mailers/notify_rb.html">app/mailers/notify.rb</a>
<a href="../files/app/models/ability_rb.html">app/models/ability.rb</a>
<a href="../files/app/models/commit_rb.html">app/models/commit.rb</a>
<a href="../files/app/models/event_rb.html">app/models/event.rb</a>
<a href="../files/app/models/gitlab_ci_service_rb.html">app/models/gitlab_ci_service.rb</a>
<a href="../files/app/models/group_rb.html">app/models/group.rb</a>
<a href="../files/app/models/issue_rb.html">app/models/issue.rb</a>
<a href="../files/app/models/key_rb.html">app/models/key.rb</a>
<a href="../files/app/models/merge_request_rb.html">app/models/merge_request.rb</a>
<a href="../files/app/models/milestone_rb.html">app/models/milestone.rb</a>
<a href="../files/app/models/namespace_rb.html">app/models/namespace.rb</a>
<a href="../files/app/models/note_rb.html">app/models/note.rb</a>
<a href="../files/app/models/project_rb.html">app/models/project.rb</a>
<a href="../files/app/models/project_hook_rb.html">app/models/project_hook.rb</a>
<a href="../files/app/models/protected_branch_rb.html">app/models/protected_branch.rb</a>
<a href="../files/app/models/service_rb.html">app/models/service.rb</a>
<a href="../files/app/models/service_hook_rb.html">app/models/service_hook.rb</a>
<a href="../files/app/models/snippet_rb.html">app/models/snippet.rb</a>
<a href="../files/app/models/system_hook_rb.html">app/models/system_hook.rb</a>
<a href="../files/app/models/tree_rb.html">app/models/tree.rb</a>
<a href="../files/app/models/user_rb.html">app/models/user.rb</a>
<a href="../files/app/models/users_project_rb.html">app/models/users_project.rb</a>
<a href="../files/app/models/web_hook_rb.html">app/models/web_hook.rb</a>
<a href="../files/app/models/wiki_rb.html">app/models/wiki.rb</a>
<a href="../files/app/observers/activity_observer_rb.html">app/observers/activity_observer.rb</a>
<a href="../files/app/observers/issue_observer_rb.html">app/observers/issue_observer.rb</a>
<a href="../files/app/observers/key_observer_rb.html">app/observers/key_observer.rb</a>
<a href="../files/app/observers/merge_request_observer_rb.html">app/observers/merge_request_observer.rb</a>
<a href="../files/app/observers/note_observer_rb.html">app/observers/note_observer.rb</a>
<a href="../files/app/observers/project_observer_rb.html">app/observers/project_observer.rb</a>
<a href="../files/app/observers/system_hook_observer_rb.html">app/observers/system_hook_observer.rb</a>
<a href="../files/app/observers/user_observer_rb.html">app/observers/user_observer.rb</a>
<a href="../files/app/observers/users_project_observer_rb.html">app/observers/users_project_observer.rb</a>
<a href="../files/app/roles/account_rb.html">app/roles/account.rb</a>
<a href="../files/app/roles/authority_rb.html">app/roles/authority.rb</a>
<a href="../files/app/roles/git_host_rb.html">app/roles/git_host.rb</a>
<a href="../files/app/roles/issue_commonality_rb.html">app/roles/issue_commonality.rb</a>
<a href="../files/app/roles/namespaced_project_rb.html">app/roles/namespaced_project.rb</a>
<a href="../files/app/roles/note_event_rb.html">app/roles/note_event.rb</a>
<a href="../files/app/roles/push_event_rb.html">app/roles/push_event.rb</a>
<a href="../files/app/roles/push_observer_rb.html">app/roles/push_observer.rb</a>
<a href="../files/app/roles/repository_rb.html">app/roles/repository.rb</a>
<a href="../files/app/roles/static_model_rb.html">app/roles/static_model.rb</a>
<a href="../files/app/roles/team_rb.html">app/roles/team.rb</a>
<a href="../files/app/roles/votes_rb.html">app/roles/votes.rb</a>
<a href="../files/app/uploaders/attachment_uploader_rb.html">app/uploaders/attachment_uploader.rb</a>
<a href="../files/app/workers/post_receive_rb.html">app/workers/post_receive.rb</a>
<a href="../files/app/workers/system_hook_worker_rb.html">app/workers/system_hook_worker.rb</a>
<a href="../files/lib/api_rb.html">lib/api.rb</a>
<a href="../files/lib/api/entities_rb.html">lib/api/entities.rb</a>
<a href="../files/lib/api/helpers_rb.html">lib/api/helpers.rb</a>
<a href="../files/lib/api/issues_rb.html">lib/api/issues.rb</a>
<a href="../files/lib/api/merge_requests_rb.html">lib/api/merge_requests.rb</a>
<a href="../files/lib/api/milestones_rb.html">lib/api/milestones.rb</a>
<a href="../files/lib/api/notes_rb.html">lib/api/notes.rb</a>
<a href="../files/lib/api/projects_rb.html">lib/api/projects.rb</a>
<a href="../files/lib/api/session_rb.html">lib/api/session.rb</a>
<a href="../files/lib/api/users_rb.html">lib/api/users.rb</a>
<a href="../files/lib/event_filter_rb.html">lib/event_filter.rb</a>
<a href="../files/lib/extracts_path_rb.html">lib/extracts_path.rb</a>
<a href="../files/lib/file_size_validator_rb.html">lib/file_size_validator.rb</a>
<a href="../files/lib/gitlab/app_logger_rb.html">lib/gitlab/app_logger.rb</a>
<a href="../files/lib/gitlab/auth_rb.html">lib/gitlab/auth.rb</a>
<a href="../files/lib/gitlab/backend/gitolite_rb.html">lib/gitlab/backend/gitolite.rb</a>
<a href="../files/lib/gitlab/backend/gitolite_config_rb.html">lib/gitlab/backend/gitolite_config.rb</a>
<a href="../files/lib/gitlab/backend/grack_auth_rb.html">lib/gitlab/backend/grack_auth.rb</a>
<a href="../files/lib/gitlab/git_logger_rb.html">lib/gitlab/git_logger.rb</a>
<a href="../files/lib/gitlab/git_stats_rb.html">lib/gitlab/git_stats.rb</a>
<a href="../files/lib/gitlab/graph/commit_rb.html">lib/gitlab/graph/commit.rb</a>
<a href="../files/lib/gitlab/graph/json_builder_rb.html">lib/gitlab/graph/json_builder.rb</a>
<a href="../files/lib/gitlab/inline_diff_rb.html">lib/gitlab/inline_diff.rb</a>
<a href="../files/lib/gitlab/logger_rb.html">lib/gitlab/logger.rb</a>
<a href="../files/lib/gitlab/markdown_rb.html">lib/gitlab/markdown.rb</a>
<a href="../files/lib/gitlab/project_mover_rb.html">lib/gitlab/project_mover.rb</a>
<a href="../files/lib/gitlab/regex_rb.html">lib/gitlab/regex.rb</a>
<a href="../files/lib/gitlab/satellite/action_rb.html">lib/gitlab/satellite/action.rb</a>
<a href="../files/lib/gitlab/satellite/edit_file_action_rb.html">lib/gitlab/satellite/edit_file_action.rb</a>
<a href="../files/lib/gitlab/satellite/merge_action_rb.html">lib/gitlab/satellite/merge_action.rb</a>
<a href="../files/lib/gitlab/satellite/satellite_rb.html">lib/gitlab/satellite/satellite.rb</a>
<a href="../files/lib/gitlab/seeder_rb.html">lib/gitlab/seeder.rb</a>
<a href="../files/lib/gitlab/theme_rb.html">lib/gitlab/theme.rb</a>
<a href="../files/lib/hooks/post-receive.html">lib/hooks/post-receive</a>
<a href="../files/lib/redcarpet/render/gitlab_html_rb.html">lib/redcarpet/render/gitlab_html.rb</a>
</body>
</html>

1
doc/code/panel/tree.js Normal file

File diff suppressed because one or more lines are too long