Skip to content

Commit 1746bc6

Browse files
committed
Add docstrings
This commit add interactive help to ROOT.jl. Docstrings were generated for all types and functions from the C++ doxy docstrings
1 parent 3f6c3a8 commit 1746bc6

File tree

3 files changed

+57645
-1
lines changed

3 files changed

+57645
-1
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,14 @@
22

33
[![Linux](https://github.com/JuliaHEP/ROOT.jl/actions/workflows/test-linux.yml/badge.svg)](https://github.com/JuliaHEP/ROOT.jl/actions/workflows/test-linux.yml) [![macOS](https://github.com/JuliaHEP/ROOT.jl/actions/workflows/test-macos.yml/badge.svg)](https://github.com/JuliaHEP/ROOT.jl/actions/workflows/test-macos.yml)
44

5+
6+
## 📣 New: use of the built-in Julia package manager to install ROOT libraries on Linux.
7+
8+
Release 0.3.4 bring interactive help to all types and methods of ROOT.jl.
9+
510
## 📣 New: use of the built-in Julia package manager to install ROOT libraries on Linux.
611

7-
Starting from release x.y.z, the built-in Julia package manager is used to install the C++ ROOT framework. This mechansim replace the Conda one, which was introduced as an interim solution and rapidly showed its limits. The ROOT libraries (and also also executables) are package in the `ROOT_jll` [JLL](https://docs.binarybuilder.org/stable/jll/#JLL-packages) package.
12+
Starting from release 0.3.3, the built-in Julia package manager is used to install the C++ ROOT framework. This mechansim replace the Conda one, which was introduced as an interim solution and rapidly showed its limits. The ROOT libraries (and also also executables) are package in the `ROOT_jll` [JLL](https://docs.binarybuilder.org/stable/jll/#JLL-packages) package.
813

914
📝 Automatic installation of the ROOT libraries is currently not supported for MacOS. It was supported for a short time by the Conda mechanism, before an update of the Conda forge repository broke the dependencies. On MacOS, the C++ ROOT framework must be installed separately using one of the [method supported by ROOT](https://root.cern/install/).
1015

src/ROOT.jl

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,9 +92,17 @@ else
9292

9393
include("def_args.jl")
9494
include("move.jl")
95+
96+
@doc """
97+
ROOT.TVectorD
98+
99+
Alias for [ROOT.TVectorT{Float64}](@ref)
100+
"""
101+
const TVectorD = TVectorT{Float64}
95102

96103
include("ROOTex.jl")
97104
include("demo.jl")
105+
include("ROOTdoc.jl")
98106
end
99107

100108
function __init__()

0 commit comments

Comments
 (0)