From 16857c2e19d79014eb3089143c82c5e0b1927958 Mon Sep 17 00:00:00 2001
From: florian <f.spreckelsen@inidscale.com>
Date: Wed, 30 Jun 2021 11:54:10 +0200
Subject: [PATCH] DOC: Add a dummy function with documentation
---
docs/make.jl | 3 +++
docs/src/index.md | 8 ++++++++
src/CaosDB.jl | 9 ++++++++-
3 files changed, 19 insertions(+), 1 deletion(-)
create mode 100644 docs/make.jl
create mode 100644 docs/src/index.md
diff --git a/docs/make.jl b/docs/make.jl
new file mode 100644
index 0000000..ede59e7
--- /dev/null
+++ b/docs/make.jl
@@ -0,0 +1,3 @@
+using Documenter, CaosDB
+
+makedocs(sitename="CaosDB.jl Documentation")
diff --git a/docs/src/index.md b/docs/src/index.md
new file mode 100644
index 0000000..ac17339
--- /dev/null
+++ b/docs/src/index.md
@@ -0,0 +1,8 @@
+# CaosDB.jl documentation
+
+This will be the index of the documentation of the CaosDB Julia client
+library.
+
+```@docs
+dummy_func(x)
+```
diff --git a/src/CaosDB.jl b/src/CaosDB.jl
index e791e20..341e2ca 100644
--- a/src/CaosDB.jl
+++ b/src/CaosDB.jl
@@ -1,5 +1,12 @@
module CaosDB
-greet() = print("Hello World!")
+export dummy_func
+
+"""
+ dummy_func(x)
+
+Returns double the number `x` plus `1`.
+"""
+dummy_func(x) = 2x + 1
end # module
--
GitLab