Merge branch 'documenter-1' into 'main'

Documenter 1

See merge request !16

docs/Project.toml

@@ -4,3 +4,6 @@ FHist = "68837c9b-b678-4cd5-9925-8a54edc8f695"
 HDF5 = "f67ccb44-e63f-5c2f-98bd-6dc0ccc4ba2f"
 KM3NeTTestData = "3249b543-581e-4f22-b7da-6c2cdf549b24"
 PGFPlotsX = "8314cec4-20b6-5062-9cdb-752b83310925"
+
+[compat]
+Documenter = "1"

docs/make.jl

@@ -10,6 +10,7 @@ makedocs(;
         collapselevel = 4,
         warn_outdated = true,
     ),
+    warnonly = [:missing_docs],
     pages = [
         "Home" => "index.md",
         "Manual" => Any[
@@ -25,7 +26,10 @@ makedocs(;
         ],
         "API" => "api.md"
     ],
-    repo = "https://git.km3net.de/common/KM3io.jl/blob/{commit}{path}#L{line}",
+    repo = Documenter.Remotes.URL(
+        "https://git.km3net.de/common/KM3io.jl/blob/{commit}{path}#L{line}",
+        "https://git.km3net.de/common/KM3io.jl"
+    ),
 )
 
 deploydocs(;

docs/src/api.md

@@ -39,6 +39,7 @@ SummaryFrame
 H5File
 H5CompoundDataset
 create_dataset
+flush
 ```
 
 ## Hardware
@@ -47,8 +48,13 @@ create_dataset
 PMT
 DetectorModule
 Detector
+write(::AbstractString, ::Detector)
+write(::IO, ::Detector)
 Hydrophone
+read(::AbstractString, ::Type{Hydrophone})
 Tripod
+read(::AbstractString, ::Type{Tripod})
+write(::AbstractString, ::Vector{Tripod})
 piezoenabled
 hydrophoneenabled
 center
@@ -63,8 +69,10 @@ center
 
 ```@docs
 Waveform
+read(filename::AbstractString, T::Type{Waveform})
 AcousticSignal
 AcousticsTriggerParameter
+read(filename::AbstractString, T::Type{AcousticsTriggerParameter})
 ```
 
 ## Calibration

src/hardware.jl

@@ -411,6 +411,11 @@ function _extract_comments(lines::Vector{T}, prefix::T) where {T<:AbstractString
 end
 
 
+"""
+Writes the detector definition to a file, according to the DETX format specification.
+The `version` parameter can be a version number or `:same`, which is the default value
+and writes the same version as the provided detector has.
+"""
 function write(filename::AbstractString, d::Detector; version=:same)
     isfile(filename) && @warn "File '$(filename)' already exists, overwriting."
     open(filename, "w") do fobj

src/physics.jl

@@ -102,6 +102,6 @@ K40Rates() = K40Rates(5200, [568.0, 49.10, 5.48, 0.48])
 """
 Return the absorption length [m] in water at a KM3NeT site for a given wavelength [nm].
 """
-function absorptionslength(λ)
-
+function absorptionlength(λ)
+    error("Not implemented yet.")
 end