Skip to content

Commit

Permalink
Get the docs building
Browse files Browse the repository at this point in the history
Note that :missing_docs is now warn-only because it was complaining about
everything in Clang.Generators, which we don't want/need to document. I didn't
have any luck ignoring those with a `Filter` either.
  • Loading branch information
JamesWrigley committed Dec 23, 2023
1 parent 25acb38 commit 49abae7
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 3 deletions.
4 changes: 3 additions & 1 deletion docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,13 @@ using Documenter

makedocs(;
modules=[Clang, Clang.LibClang],
repo="https://github.com/JuliaInterop/Clang.jl/blob/{commit}{path}#L{line}",
repo=Remotes.GitHub("JuliaInterop", "Clang.jl"),
sitename="Clang.jl",
format=Documenter.HTML(;
prettyurls=get(ENV, "CI", "false") == "true",
canonical="https://JuliaInterop.github.io/Clang.jl",
assets=String[],
size_threshold=700000
),
pages=[
"Introduction" => "index.md",
Expand All @@ -18,6 +19,7 @@ makedocs(;
"LibClang Wrapper API Reference" => "libclang.md",
"Clang API Reference" => "api.md",
],
warnonly=:missing_docs
)

deploydocs(; repo="github.com/JuliaInterop/Clang.jl.git")
2 changes: 1 addition & 1 deletion src/compiledb.jl
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ end
CLCompileCommand
Represents a command to compile the specific file.
Call [`getDirectory`](@ref), [`getArguments`](@ref) and [`getArguments`](@ref) to get its attributes.
Call [`getDirection`](@ref), [`getArguments`](@ref) and [`getArguments`](@ref) to get its attributes.
"""
mutable struct CLCompileCommand
# Keep a reference to its root
Expand Down
2 changes: 1 addition & 1 deletion src/type.jl
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ getPointeeType(t::CLType)::CLType = clang_getPointeeType(t)
getTypeDeclaration(t::CXType) -> CXCursor
getTypeDeclaration(t::CLType) -> CLCursor
Return the cursor for the declaration of the given type. To get the type of the cursor,
see [`type`](@ref). Wrapper for libclang's [`clang_getTypeDeclaration`](@ref).
see [`getCursorType`](@ref). Wrapper for libclang's [`clang_getTypeDeclaration`](@ref).
"""
getTypeDeclaration(t::CXType) = clang_getTypeDeclaration(t)
getTypeDeclaration(t::CLType)::CLCursor = clang_getTypeDeclaration(t)
Expand Down

0 comments on commit 49abae7

Please sign in to comment.