Skip to content

Commit

Permalink
fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
hverhelst committed Dec 13, 2024
1 parent 86a5c08 commit 73ee90c
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 10 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
docs/build/*
12 changes: 12 additions & 0 deletions docs/src/gsMatrix.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# gsMatrix

## Function Documentation
```@autodocs
Modules = [Gismo]
Pages = ["src/gsMatrix.jl"]
Order = [:function, :type]
```

```@contents
Pages = Main.SUBSECTION_PAGES
```
10 changes: 7 additions & 3 deletions src/gsMatrix.jl
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
export
EigenMatrix

########################################################################
# gsMatrix
########################################################################
Expand All @@ -15,8 +18,9 @@ Creates an empty matrix.
# Example
```jldoctest
```jldoctest output=(false)
m = EigenMatrix()
# output
```
"""
mutable struct EigenMatrix
Expand Down Expand Up @@ -57,8 +61,8 @@ Returns the number of rows in the matrix.
# Examples
```jldoctest myEigenMatrix
julia> m = EigenMatrix(3,3)
julia> print(rows(m))
m = EigenMatrix(3,3)
print(Gismo.rows(m))
# output
3
```
Expand Down
15 changes: 8 additions & 7 deletions src/gsNurbs.jl
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,9 @@ export
- `a::Vector{Float64}`: the knot vector
# Examples
```jldoctest myKnotVector
julia> kv = KnotVector(Float64[0.,0.,0.,0.,0.5,1.,1.,1.,1.])
```jldoctest myKnotVector; output=(false)
kv = KnotVector(Float64[0.,0.,0.,0.,0.5,1.,1.,1.,1.])
# output
```
"""
mutable struct KnotVector
Expand Down Expand Up @@ -56,11 +57,11 @@ Returns the number of elements in the knot vector.
- `kv::KnotVector`: the knot vector
# Examples
```jldoctest myKnotVector
julia> print(Gismo.size(kv))
# output
9
```
# ```jldoctest output=(false)
# kv = KnotVector(Float64[0.,0.,0.,0.,0.5,1.,1.,1.,1.])
# print(Gismo.size(kv))
# # output
# ```
"""
function size(kv::KnotVector)::Int64
return ccall((:gsKnotVector_size,libgismo),Cint,(Ptr{gsCKnotVector},),kv.ptr)
Expand Down

0 comments on commit 73ee90c

Please sign in to comment.