Skip to content

Commit

Permalink
Refreshes Retype-generated documentation.
Browse files Browse the repository at this point in the history 
Process triggered by wanteatfruit.
  • Loading branch information
Retype GitHub Action committed Nov 10, 2023
1 parent c1a6cf0 commit f620eca
Show file tree
Hide file tree
Showing 8 changed files with 142 additions and 72 deletions.
8 changes: 4 additions & 4 deletions 404.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.751863217992">
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.752900671892">

<!-- See retype.com -->
<meta name="generator" content="Retype 3.5.0">
Expand All @@ -27,11 +27,11 @@

<script data-cfasync="false">(function () { var el = document.documentElement, m = localStorage.getItem("doc_theme"), wm = window.matchMedia; if (m === "dark" || (!m && wm && wm("(prefers-color-scheme: dark)").matches)) { el.classList.add("dark") } else { el.classList.remove("dark") } })();</script>

<link href="/resources/css/retype.css?v=3.5.0.751863217992" rel="stylesheet">
<link href="/resources/css/retype.css?v=3.5.0.752900671892" rel="stylesheet">

<script data-cfasync="false" src="/resources/js/config.js?v=3.5.0.751863217992" data-turbo-eval="false" defer></script>
<script data-cfasync="false" src="/resources/js/config.js?v=3.5.0.752900671892" data-turbo-eval="false" defer></script>
<script data-cfasync="false" src="/resources/js/retype.js?v=3.5.0" data-turbo-eval="false" defer></script>
<script id="lunr-js" data-cfasync="false" src="/resources/js/lunr.js?v=3.5.0.751863217992" data-turbo-eval="false" defer></script>
<script id="lunr-js" data-cfasync="false" src="/resources/js/lunr.js?v=3.5.0.752900671892" data-turbo-eval="false" defer></script>
</head>
<body>
<div id="docs-app" class="relative text-base antialiased text-gray-700 bg-white font-body dark:bg-dark-850 dark:text-dark-300">
Expand Down
31 changes: 18 additions & 13 deletions api-reference/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.751863217992">
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.752900671892">

<!-- See retype.com -->
<meta name="generator" content="Retype 3.5.0">

<!-- Primary Meta Tags -->
<title>Real-time Data API Reference</title>
<meta name="title" content="Real-time Data API Reference">
<meta name="description" content="We provide a real-time data API for future plug-in developers and researchers to get the real-time data from IDE tracker and eye tracker separately.">
<meta name="description" content="We provide a real-time data API for future plugin developers and researchers to get the real-time data from IDE tracker and eye tracker separately.">

<!-- Canonical -->
<link rel="canonical" href="/api-reference/">
Expand All @@ -20,22 +20,22 @@
<meta property="og:type" content="website">
<meta property="og:url" content="/api-reference/">
<meta property="og:title" content="Real-time Data API Reference">
<meta property="og:description" content="We provide a real-time data API for future plug-in developers and researchers to get the real-time data from IDE tracker and eye tracker separately.">
<meta property="og:description" content="We provide a real-time data API for future plugin developers and researchers to get the real-time data from IDE tracker and eye tracker separately.">

<!-- Twitter -->
<meta property="twitter:card" content="summary_large_image">
<meta property="twitter:url" content="/api-reference/">
<meta property="twitter:title" content="Real-time Data API Reference">
<meta property="twitter:description" content="We provide a real-time data API for future plug-in developers and researchers to get the real-time data from IDE tracker and eye tracker separately.">
<meta property="twitter:description" content="We provide a real-time data API for future plugin developers and researchers to get the real-time data from IDE tracker and eye tracker separately.">

<script data-cfasync="false">(function () { var el = document.documentElement, m = localStorage.getItem("doc_theme"), wm = window.matchMedia; if (m === "dark" || (!m && wm && wm("(prefers-color-scheme: dark)").matches)) { el.classList.add("dark") } else { el.classList.remove("dark") } })();</script>

<link href="../resources/css/retype.css?v=3.5.0.751863217992" rel="stylesheet">
<link href="../resources/css/retype.css?v=3.5.0.752900671892" rel="stylesheet">

<script data-cfasync="false" src="../resources/js/config.js?v=3.5.0.751863217992" data-turbo-eval="false" defer></script>
<script data-cfasync="false" src="../resources/js/config.js?v=3.5.0.752900671892" data-turbo-eval="false" defer></script>
<script data-cfasync="false" src="../resources/js/retype.js?v=3.5.0" data-turbo-eval="false" defer></script>
<script id="lunr-js" data-cfasync="false" src="../resources/js/lunr.js?v=3.5.0.751863217992" data-turbo-eval="false" defer></script>
<script id="prism-js" data-cfasync="false" src="../resources/js/prism.js?v=3.5.0.751863217992" defer></script>
<script id="lunr-js" data-cfasync="false" src="../resources/js/lunr.js?v=3.5.0.752900671892" data-turbo-eval="false" defer></script>
<script id="prism-js" data-cfasync="false" src="../resources/js/prism.js?v=3.5.0.752900671892" defer></script>
</head>
<body>
<div id="docs-app" class="relative text-base antialiased text-gray-700 bg-white font-body dark:bg-dark-850 dark:text-dark-300">
Expand Down Expand Up @@ -162,21 +162,26 @@ <h2>
<span>Overview</span>
</h2>
</doc-anchor-target>
<p>We provide a real-time data API for future plug-in developers and researchers to get the real-time data from IDE tracker and eye tracker separately. The API is based on the <doc-anchor-trigger to="#ide-tracker">IDE Tracker</doc-anchor-trigger> and <doc-anchor-trigger to="#eye-tracker">Eye Tracker</doc-anchor-trigger>.</p>
<p>We provide a real-time data API for future plugin developers and researchers to get the real-time data from IDE tracker and eye tracker separately. The API is based on the <doc-anchor-trigger to="#ide-tracker">IDE Tracker</doc-anchor-trigger> and <doc-anchor-trigger to="#eye-tracker">Eye Tracker</doc-anchor-trigger>.</p>
<doc-anchor-target id="configuration">
<h2>
<doc-anchor-trigger class="header-anchor-trigger" to="#configuration">#</doc-anchor-trigger>
<span>Configuration</span>
</h2>
</doc-anchor-target>
<p>add dependency stuff</p>
<p>Before using the API, you first need to add the following dependency to the <code v-pre>intellij</code> section in <code v-pre>build.gradle.kts</code> file.</p>
<div class="codeblock-wrapper"><doc-codeblock>
<pre class="language-groovy"><code v-pre class="language-groovy">intellij {
plugins.set(file(&quot;path-to-CodeGRITS-project\\build\\idea-sandbox\\plugins\\CodeVision&quot;))
}</code></pre>
</doc-codeblock></div>
<doc-anchor-target id="quick-start">
<h2>
<doc-anchor-trigger class="header-anchor-trigger" to="#quick-start">#</doc-anchor-trigger>
<span>Quick Start</span>
</h2>
</doc-anchor-target>
<p>describe how to use the API</p>
<p>To use the API, simply call the <code v-pre>getInstance()</code> method to get the instance of the IDE Tracker or Eye Tracker. Then, set the <code v-pre>isRealTimeDataTransmitting</code> to <code v-pre>true</code> to enable the real-time data transmitting. After that, set the <code v-pre>ideTrackerDataHandler</code> or <code v-pre>eyeTrackerDataHandler</code> to handle the real-time data. Finally, call the <code v-pre>startTracking()</code> method to start tracking.</p>
<div class="codeblock-wrapper"><doc-codeblock>
<pre class="language-java"><code v-pre class="language-java">IDETracker ideTracker = IDETracker.getInstance();
ideTracker.setIsRealTimeDataTransmitting(true);
Expand Down Expand Up @@ -272,11 +277,11 @@ <h4>

<nav class="flex mt-14">
<div class="w-1/2">
<a class="px-5 py-4 h-full flex items-center break-normal font-medium text-blue-500 dark:text-blue-400 border border-gray-300 hover:border-gray-400 dark:border-dark-650 dark:hover:border-dark-450 rounded-r rounded-l-lg transition-colors duration-150 relative hover:z-5" href="../document/">
<a class="px-5 py-4 h-full flex items-center break-normal font-medium text-blue-500 dark:text-blue-400 border border-gray-300 hover:border-gray-400 dark:border-dark-650 dark:hover:border-dark-450 rounded-r rounded-l-lg transition-colors duration-150 relative hover:z-5" href="../output-format/">
<svg xmlns="http://www.w3.org/2000/svg" class="mr-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19 11H7.41l5.29-5.29a.996.996 0 10-1.41-1.41l-7 7a1 1 0 000 1.42l7 7a1.024 1.024 0 001.42-.01.996.996 0 000-1.41L7.41 13H19c.55 0 1-.45 1-1s-.45-1-1-1z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
<span>
<span class="block text-xs font-normal text-gray-400 dark:text-dark-400">Previous</span>
<span class="block mt-1">Code​GRITS Documentation</span>
<span class="block mt-1">Output Format</span>
</span>
</a>
</div>
Expand Down
Loading

0 comments on commit f620eca

Please sign in to comment.