Commit a24af17a authored by 35V LG84's avatar 35V LG84

docs: fix scaladoc links

Signed-off-by: 35V LG84's avatar35V LG84 <35vlg84-x4e6b92@e257.fi>
parent 66a3c73d
Pipeline #68624084 passed with stage
in 7 minutes and 58 seconds
......@@ -2,8 +2,8 @@ image:https://gitlab.com/e257/accounting/tackler/badges/master/build.svg["Build
image:https://gitlab.com/e257/accounting/tackler/badges/master/coverage.svg["Coverage", link="https://gitlab.com/e257/accounting/tackler/-/jobs/"]
image:https://api.bintray.com/packages/e257/tackler/tackler-cli/images/download.svg[link="https://bintray.com/e257/tackler/tackler-cli/_latestVersion"]
image:https://maven-badges.herokuapp.com/maven-central/fi.e257/tackler-core_2.12/badge.svg["Maven Central", link="https://maven-badges.herokuapp.com/maven-central/fi.e257/tackler-core_2.12"] +
image:https://tackler.e257.fi/img/scaladoc-core.svg["ScalaDoc: tackler-core", link="https://javadoc.io/page/fi.e257/tackler-core_2.12/latest/fi/e257/tackler/index.html"]
image:https://tackler.e257.fi/img/scaladoc-api.svg["ScalaDoc: tackler-api", link="https://javadoc.io/page/fi.e257/tackler-api_2.12/latest/fi/e257/tackler/api/index.html"]
image:/img/scaladoc-core.svg["ScalaDoc: tackler-core", link="https://tackler.e257.fi/scaladoc/fi.e257/tackler-core_2.12/latest/fi/e257/tackler/index.html"]
image:/img/scaladoc-api.svg[ "ScalaDoc: tackler-api", link="https://tackler.e257.fi/scaladoc/fi.e257/tackler-api_2.12/latest/fi/e257/tackler/api/index.html"]
image:https://www.scala-js.org/assets/badges/scalajs-0.6.17.svg["Scala.js",link="https://www.scala-js.org"]
= Tackler
......
= Client API
:page-date: 2019-03-29 00:00:00 Z
:page-last_modified_at: 2019-03-29 00:00:00 Z
:page-last_modified_at: 2019-06-29 00:00:00 Z
image:/img/scaladoc-core.svg["ScalaDoc: tackler-core", link="https://javadoc.io/page/fi.e257/tackler-core_2.12/latest/fi/e257/tackler/index.html"]
image:/img/scaladoc-api.svg["ScalaDoc: tackler-api", link="https://javadoc.io/page/fi.e257/tackler-api_2.12/latest/fi/e257/tackler/api/index.html"]
image:/img/scaladoc-core.svg["ScalaDoc: tackler-core", link="https://tackler.e257.fi/scaladoc/fi.e257/tackler-core_2.12/latest/fi/e257/tackler/index.html"]
image:/img/scaladoc-api.svg[ "ScalaDoc: tackler-api", link="https://tackler.e257.fi/scaladoc/fi.e257/tackler-api_2.12/latest/fi/e257/tackler/api/index.html"]
image:/img/scalajs-0.6.17.svg["Scala.js",link="https://www.scala-js.org"]
This document explains how to use Tackler API on JVM and JS environments.
== tackler-api
Dependency settings for SBT are:
libraryDependencies += "fi.e257" %%% "tackler-api" % "version-number"
This is released on Maven Central Repository.
== API data models
Tackler's client side api (`tackler-api`) has data models of reports which can be used on the client side.
This api is provided for both JVM and JS environments via ScalaJS.
......@@ -45,12 +56,3 @@ There are several examples of how to define complex transaction filters in the t
{gitlink}/core/src/test/scala/fi/e257/tackler/filter[core -> tests -> filter]
== tackler-api
Dependency settings for SBT are:
libraryDependencies += "fi.e257" %%% "tackler-api" % "version-number"
This is released on Maven Central Repository.
= Server API
:page-date: 2019-03-29 00:00:00 Z
:page-last_modified_at: 2019-03-29 00:00:00 Z
:page-last_modified_at: 2019-06-29 00:00:00 Z
image:/img/scaladoc-core.svg["ScalaDoc: tackler-core", link="https://javadoc.io/page/fi.e257/tackler-core_2.12/latest/fi/e257/tackler/index.html"]
image:/img/scaladoc-api.svg["ScalaDoc: tackler-api", link="https://javadoc.io/page/fi.e257/tackler-api_2.12/latest/fi/e257/tackler/api/index.html"]
image:/img/scaladoc-core.svg["ScalaDoc: tackler-core", link="https://tackler.e257.fi/scaladoc/fi.e257/tackler-core_2.12/latest/fi/e257/tackler/index.html"]
image:/img/scaladoc-api.svg[ "ScalaDoc: tackler-api", link="https://tackler.e257.fi/scaladoc/fi.e257/tackler-api_2.12/latest/fi/e257/tackler/api/index.html"]
This document explains how to embedded Tackler core and use it as a library in other systems.
......@@ -93,7 +93,7 @@ Tackler's CLI contains examples (`git2Txns` and `paths2Txns`) how to use FS or G
{gitlink}/cli/src/main/scala/fi/e257/tackler/cli/TacklerCli.scala[cli -> main -> TacklerCli]
Test cases for GIT input are located here:
{gitlink}/core/src/test/scala/fi/e257/tackler/parser/TacklerTxnsGitTest.scala[core -> test -> parser -> TacklerTxnsGitTest]
{gitlink}/core/src/it/scala/fi/e257/tackler/parser/TacklerTxnsGitTest.scala[core -> it -> parser -> TacklerTxnsGitTest]
Complete test cases for Report API are located here:
{gitlink}/core/src/test/scala/fi/e257/tackler/report/ReportApiTest.scala[core -> test -> report -> ReportApiTest]
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment