Skip to content

Commit 0f5f35a

Browse files
committed
Remove @doc
1 parent 0e81ffe commit 0f5f35a

File tree

2 files changed

+9
-5
lines changed

2 files changed

+9
-5
lines changed

src/BandedBlockBandedMatrix.jl

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -83,13 +83,15 @@ BandedBlockBandedMatrix{T}(::Uninitialized, block_sizes::BandedBlockBandedSizes)
8383
_BandedBlockBandedMatrix(
8484
PseudoBlockArray{T}(uninitialized, block_sizes.data_block_sizes), block_sizes)
8585

86-
@doc """
87-
BlockBandedMatrix{T}(uninitialized, (rows, cols), (l, u), (λ, μ))
86+
"""
87+
BandedBlockBandedMatrix{T}(uninitialized, (rows, cols), (l, u), (λ, μ))
8888
8989
returns an uninitialized `sum(rows)`×`sum(cols)` banded-block-banded matrix `A`
9090
of type `T` with block-bandwidths `(l,u)` and where `A[Block(K,J)]`
9191
is a `BandedMatrix{T}` of size `rows[K]`×`cols[J]` with bandwidths `(λ,μ)`.
9292
"""
93+
BandedBlockBandedMatrix
94+
9395
BandedBlockBandedMatrix{T}(::Uninitialized, dims::NTuple{2, AbstractVector{Int}},
9496
lu::NTuple{2, Int}, λμ::NTuple{2, Int}) where T =
9597
BandedBlockBandedMatrix{T}(uninitialized, BandedBlockBandedSizes(dims..., lu..., λμ...))
@@ -352,15 +354,15 @@ end
352354
# end
353355
# end
354356

355-
@doc """
357+
"""
356358
subblockbandwidths(A)
357359
358360
returns the sub-block bandwidths of `A`, where `A` is a banded-block-banded
359361
matrix. In other words, `A[Block(K,J)]` will return a `BandedMatrix` with
360362
bandwidths given by `subblockbandwidths(A)`.
361363
"""
362364
subblockbandwidths(A::BandedBlockBandedMatrix) = A.λ, A.μ
363-
@doc """
365+
"""
364366
subblockbandwidth(A, i)
365367
366368
returns the sub-block lower (`i == 1`) or upper (`i == 2`) bandwidth of `A`,

src/BlockBandedMatrix.jl

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,13 +101,15 @@ end
101101
@inline BlockBandedMatrix{T}(::Uninitialized, block_sizes::BlockBandedSizes) where T =
102102
_BlockBandedMatrix(Vector{T}(uninitialized, bb_numentries(block_sizes)), block_sizes)
103103

104-
@doc """
104+
"""
105105
BlockBandedMatrix{T}(uninitialized, (rows, cols), (l, u))
106106
107107
returns an uninitialized `sum(rows)`×`sum(cols)` block-banded matrix `A`
108108
of type `T` with block-bandwidths `(l,u)` and where `A[Block(K,J)]`
109109
is a `Matrix{T}` of size `rows[K]`×`cols[J]`.
110110
"""
111+
BlockBandedMatrix
112+
111113
@inline BlockBandedMatrix{T}(::Uninitialized, dims::NTuple{2, AbstractVector{Int}}, lu::NTuple{2, Int}) where T =
112114
BlockBandedMatrix{T}(uninitialized, BlockBandedSizes(dims..., lu...))
113115

0 commit comments

Comments
 (0)