Skip to content
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.

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

added 2.0.2 docs to the docs site #604

Merged
merged 1 commit into from
Dec 5, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion _data/sidenav.yml
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,8 @@ main:
text: 'Docs',
childPages: [
{ url: '/docs/gradle-tasks/', text: 'Gradle Tasks' },
{ url: '/docs/server-side/', text: 'Server Side (xqy, sjs)' }
{ url: '/docs/server-side/', text: 'Server Side (xqy, sjs)' },
{ url: '/Javadocs/', text: 'javadocs' }
]
}
- { url: '/faqs/', text: 'FAQs' }
Expand Down
6 changes: 6 additions & 0 deletions _includes/javadoclinks.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{% for image in site.static_files %}
{% assign parts = (image.path | split: "/") %}
{% if parts.size == 4 and parts[1] == 'javadocs' and parts[3] == 'index.html' %}
<p><a href="{{parts[2]}}/">MarkLogic Data Hub Framework {{parts[2]}}</a></p>
{% endif %}
{% endfor %}
1 change: 1 addition & 0 deletions _pages/docs/docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ permalink: /docs/

1. [DHF Server Side Library](./serverside.md)
1. [Gradle Plugin tasks](./gradletasks.md)
1. [Javadocs](./javadocs.md)
13 changes: 13 additions & 0 deletions _pages/docs/javadocs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
layout: inner
title: Javadocs
permalink: /javadocs/
---

# DHF Javadocs

The following Javadocs are for the Data Hub Framework jar file. Use these Javadocs if you are writing custom code that uses the Data Hub Framework as a library.

Pick your version:

{% include javadoclinks.html %}
87 changes: 87 additions & 0 deletions javadocs/2.0.2/allclasses-frame.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_101) on Mon Dec 04 13:00:57 EST 2017 -->
<title>All Classes (marklogic-data-hub 2.0.2 API)</title>
<meta name="date" content="2017-12-04">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
<body>
<h1 class="bar">All&nbsp;Classes</h1>
<div class="indexContainer">
<ul>
<li><a href="com/marklogic/hub/entity/AbstractEntity.html" title="class in com.marklogic.hub.entity" target="classFrame">AbstractEntity</a></li>
<li><a href="com/marklogic/com/marklogic/client/ext/file/CacheBusterDocumentFileProcessor.html" title="class in com.marklogic.com.marklogic.client.ext.file" target="classFrame">CacheBusterDocumentFileProcessor</a></li>
<li><a href="com/marklogic/hub/error/CantUpgradeException.html" title="class in com.marklogic.hub.error" target="classFrame">CantUpgradeException</a></li>
<li><a href="com/marklogic/hub/flow/CodeFormat.html" title="enum in com.marklogic.hub.flow" target="classFrame">CodeFormat</a></li>
<li><a href="com/marklogic/hub/collector/Collector.html" title="interface in com.marklogic.hub.collector" target="classFrame"><span class="interfaceName">Collector</span></a></li>
<li><a href="com/marklogic/hub/collector/impl/CollectorImpl.html" title="class in com.marklogic.hub.collector.impl" target="classFrame">CollectorImpl</a></li>
<li><a href="com/marklogic/hub/flow/DataFormat.html" title="enum in com.marklogic.hub.flow" target="classFrame">DataFormat</a></li>
<li><a href="com/marklogic/hub/DataHub.html" title="class in com.marklogic.hub" target="classFrame">DataHub</a></li>
<li><a href="com/marklogic/hub/DataHubUpgrader.html" title="class in com.marklogic.hub" target="classFrame">DataHubUpgrader</a></li>
<li><a href="com/marklogic/client/datamovement/impl/DataMovementServices.html" title="class in com.marklogic.client.datamovement.impl" target="classFrame">DataMovementServices</a></li>
<li><a href="com/marklogic/hub/Debugging.html" title="class in com.marklogic.hub" target="classFrame">Debugging</a></li>
<li><a href="com/marklogic/hub/deploy/commands/DeployHubDatabaseCommand.html" title="class in com.marklogic.hub.deploy.commands" target="classFrame">DeployHubDatabaseCommand</a></li>
<li><a href="com/marklogic/hub/deploy/commands/DeployHubDatabasesCommand.html" title="class in com.marklogic.hub.deploy.commands" target="classFrame">DeployHubDatabasesCommand</a></li>
<li><a href="com/marklogic/hub/deploy/commands/DeployHubMimetypesCommand.html" title="class in com.marklogic.hub.deploy.commands" target="classFrame">DeployHubMimetypesCommand</a></li>
<li><a href="com/marklogic/hub/deploy/commands/DeployHubOtherDatabasesCommand.html" title="class in com.marklogic.hub.deploy.commands" target="classFrame">DeployHubOtherDatabasesCommand</a></li>
<li><a href="com/marklogic/hub/deploy/commands/DeployHubRolesCommand.html" title="class in com.marklogic.hub.deploy.commands" target="classFrame">DeployHubRolesCommand</a></li>
<li><a href="com/marklogic/hub/deploy/commands/DeployHubSchemasDatabaseCommand.html" title="class in com.marklogic.hub.deploy.commands" target="classFrame">DeployHubSchemasDatabaseCommand</a></li>
<li><a href="com/marklogic/hub/deploy/commands/DeployHubServersCommand.html" title="class in com.marklogic.hub.deploy.commands" target="classFrame">DeployHubServersCommand</a></li>
<li><a href="com/marklogic/hub/deploy/commands/DeployHubTriggersDatabaseCommand.html" title="class in com.marklogic.hub.deploy.commands" target="classFrame">DeployHubTriggersDatabaseCommand</a></li>
<li><a href="com/marklogic/hub/deploy/commands/DeployHubUsersCommand.html" title="class in com.marklogic.hub.deploy.commands" target="classFrame">DeployHubUsersCommand</a></li>
<li><a href="com/marklogic/hub/collector/DiskQueue.html" title="class in com.marklogic.hub.collector" target="classFrame">DiskQueue</a></li>
<li><a href="com/marklogic/hub/entity/Entity.html" title="interface in com.marklogic.hub.entity" target="classFrame"><span class="interfaceName">Entity</span></a></li>
<li><a href="com/marklogic/com/marklogic/client/ext/modulesloader/impl/EntityDefModulesFinder.html" title="class in com.marklogic.com.marklogic.client.ext.modulesloader.impl" target="classFrame">EntityDefModulesFinder</a></li>
<li><a href="com/marklogic/hub/entity/EntityImpl.html" title="class in com.marklogic.hub.entity" target="classFrame">EntityImpl</a></li>
<li><a href="com/marklogic/hub/EntityManager.html" title="class in com.marklogic.hub" target="classFrame">EntityManager</a></li>
<li><a href="com/marklogic/hub/util/FileUtil.html" title="class in com.marklogic.hub.util" target="classFrame">FileUtil</a></li>
<li><a href="com/marklogic/hub/flow/Flow.html" title="interface in com.marklogic.hub.flow" target="classFrame"><span class="interfaceName">Flow</span></a></li>
<li><a href="com/marklogic/hub/flow/FlowBuilder.html" title="class in com.marklogic.hub.flow" target="classFrame">FlowBuilder</a></li>
<li><a href="com/marklogic/hub/flow/FlowFinishedListener.html" title="interface in com.marklogic.hub.flow" target="classFrame"><span class="interfaceName">FlowFinishedListener</span></a></li>
<li><a href="com/marklogic/hub/flow/impl/FlowImpl.html" title="class in com.marklogic.hub.flow.impl" target="classFrame">FlowImpl</a></li>
<li><a href="com/marklogic/hub/flow/FlowItemCompleteListener.html" title="interface in com.marklogic.hub.flow" target="classFrame"><span class="interfaceName">FlowItemCompleteListener</span></a></li>
<li><a href="com/marklogic/hub/flow/FlowItemFailureListener.html" title="interface in com.marklogic.hub.flow" target="classFrame"><span class="interfaceName">FlowItemFailureListener</span></a></li>
<li><a href="com/marklogic/hub/FlowManager.html" title="class in com.marklogic.hub" target="classFrame">FlowManager</a></li>
<li><a href="com/marklogic/hub/flow/FlowRunner.html" title="interface in com.marklogic.hub.flow" target="classFrame"><span class="interfaceName">FlowRunner</span></a></li>
<li><a href="com/marklogic/hub/flow/impl/FlowRunnerImpl.html" title="class in com.marklogic.hub.flow.impl" target="classFrame">FlowRunnerImpl</a></li>
<li><a href="com/marklogic/hub/flow/FlowStatusListener.html" title="interface in com.marklogic.hub.flow" target="classFrame"><span class="interfaceName">FlowStatusListener</span></a></li>
<li><a href="com/marklogic/hub/flow/FlowType.html" title="enum in com.marklogic.hub.flow" target="classFrame">FlowType</a></li>
<li><a href="com/marklogic/hub/deploy/HubAppDeployer.html" title="class in com.marklogic.hub.deploy" target="classFrame">HubAppDeployer</a></li>
<li><a href="com/marklogic/hub/HubConfig.html" title="class in com.marklogic.hub" target="classFrame">HubConfig</a></li>
<li><a href="com/marklogic/hub/HubDatabase.html" title="enum in com.marklogic.hub" target="classFrame">HubDatabase</a></li>
<li><a href="com/marklogic/hub/deploy/util/HubDeployStatusListener.html" title="interface in com.marklogic.hub.deploy.util" target="classFrame"><span class="interfaceName">HubDeployStatusListener</span></a></li>
<li><a href="com/marklogic/hub/deploy/util/HubFileFilter.html" title="class in com.marklogic.hub.deploy.util" target="classFrame">HubFileFilter</a></li>
<li><a href="com/marklogic/hub/util/HubModuleManager.html" title="class in com.marklogic.hub.util" target="classFrame">HubModuleManager</a></li>
<li><a href="com/marklogic/hub/HubProject.html" title="class in com.marklogic.hub" target="classFrame">HubProject</a></li>
<li><a href="com/marklogic/hub/InstallInfo.html" title="class in com.marklogic.hub" target="classFrame">InstallInfo</a></li>
<li><a href="com/marklogic/hub/job/Job.html" title="class in com.marklogic.hub.job" target="classFrame">Job</a></li>
<li><a href="com/marklogic/hub/job/JobDeleteResponse.html" title="class in com.marklogic.hub.job" target="classFrame">JobDeleteResponse</a></li>
<li><a href="com/marklogic/hub/job/JobManager.html" title="class in com.marklogic.hub.job" target="classFrame">JobManager</a></li>
<li><a href="com/marklogic/hub/job/JobStatus.html" title="enum in com.marklogic.hub.job" target="classFrame">JobStatus</a></li>
<li><a href="com/marklogic/hub/util/JsonXor.html" title="class in com.marklogic.hub.util" target="classFrame">JsonXor</a></li>
<li><a href="com/marklogic/hub/error/LegacyFlowsException.html" title="class in com.marklogic.hub.error" target="classFrame">LegacyFlowsException</a></li>
<li><a href="com/marklogic/hub/deploy/commands/LoadHubModulesCommand.html" title="class in com.marklogic.hub.deploy.commands" target="classFrame">LoadHubModulesCommand</a></li>
<li><a href="com/marklogic/hub/deploy/commands/LoadUserModulesCommand.html" title="class in com.marklogic.hub.deploy.commands" target="classFrame">LoadUserModulesCommand</a></li>
<li><a href="com/marklogic/hub/main/MainPlugin.html" title="interface in com.marklogic.hub.main" target="classFrame"><span class="interfaceName">MainPlugin</span></a></li>
<li><a href="com/marklogic/hub/main/impl/MainPluginImpl.html" title="class in com.marklogic.hub.main.impl" target="classFrame">MainPluginImpl</a></li>
<li><a href="com/marklogic/hub/util/MlcpConsumer.html" title="class in com.marklogic.hub.util" target="classFrame">MlcpConsumer</a></li>
<li><a href="com/marklogic/hub/util/MlcpRunner.html" title="class in com.marklogic.hub.util" target="classFrame">MlcpRunner</a></li>
<li><a href="com/marklogic/hub/util/PerformanceLogger.html" title="class in com.marklogic.hub.util" target="classFrame">PerformanceLogger</a></li>
<li><a href="com/marklogic/hub/PreInstallCheck.html" title="class in com.marklogic.hub" target="classFrame">PreInstallCheck</a></li>
<li><a href="com/marklogic/hub/util/ProcessRunner.html" title="class in com.marklogic.hub.util" target="classFrame">ProcessRunner</a></li>
<li><a href="com/marklogic/hub/flow/RunFlowResponse.html" title="class in com.marklogic.hub.flow" target="classFrame">RunFlowResponse</a></li>
<li><a href="com/marklogic/hub/scaffold/Scaffolding.html" title="class in com.marklogic.hub.scaffold" target="classFrame">Scaffolding</a></li>
<li><a href="com/marklogic/hub/error/ScaffoldingValidationException.html" title="class in com.marklogic.hub.error" target="classFrame">ScaffoldingValidationException</a></li>
<li><a href="com/marklogic/hub/scaffold/ScaffoldingValidator.html" title="class in com.marklogic.hub.scaffold" target="classFrame">ScaffoldingValidator</a></li>
<li><a href="com/marklogic/com/marklogic/client/ext/modulesloader/impl/SearchOptionsFinder.html" title="class in com.marklogic.com.marklogic.client.ext.modulesloader.impl" target="classFrame">SearchOptionsFinder</a></li>
<li><a href="com/marklogic/hub/error/ServerValidationException.html" title="class in com.marklogic.hub.error" target="classFrame">ServerValidationException</a></li>
<li><a href="com/marklogic/hub/util/StreamGobbler.html" title="class in com.marklogic.hub.util" target="classFrame">StreamGobbler</a></li>
<li><a href="com/marklogic/hub/Tracing.html" title="class in com.marklogic.hub" target="classFrame">Tracing</a></li>
<li><a href="com/marklogic/com/marklogic/client/ext/modulesloader/impl/UserModulesFinder.html" title="class in com.marklogic.com.marklogic.client.ext.modulesloader.impl" target="classFrame">UserModulesFinder</a></li>
</ul>
</div>
</body>
</html>
Loading