Added documentation to libdl module (#52825)

Part of #52725 --------- Co-authored-by: RichieWilynnton <[email protected]> Co-authored-by: Steven G. Johnson <[email protected]> Co-authored-by: Jameson Nash <[email protected]> Co-authored-by: inky <[email protected]> Co-authored-by: Max Horn <[email protected]>
JuliaLang · Feb 8, 2024 · 815cfd5 · 815cfd5
1 parent c1a7bb2
commit 815cfd5
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 4 deletions.
diff --git a/stdlib/Libdl/docs/src/index.md b/stdlib/Libdl/docs/src/index.md
@@ -2,6 +2,10 @@
 EditURL = "https://github.com/JuliaLang/julia/blob/master/stdlib/Libdl/docs/src/index.md"
 ```
 
+```@docs
+Libdl
+```
+
 # Dynamic Linker
 
 ```@docs

diff --git a/stdlib/Libdl/src/Libdl.jl b/stdlib/Libdl/src/Libdl.jl
@@ -1,5 +1,10 @@
 # This file is a part of Julia. License is MIT: https://julialang.org/license
-
+"""
+The Libdl module in Julia provides specialized and lower-level facilities for dynamic linking with shared libraries. While Julia
+inherently supports linking to runtime shared libraries through the `ccall` intrinsic, `Libdl` extends this capability by offering additional, more
+granular control. It enables users to search for shared libraries both in memory and the filesystem, manually load them with specific runtime linker options, and look up
+library symbols as low-level pointers.
+"""
 module Libdl
 # Just re-export Base.Libc.Libdl:
 export DL_LOAD_PATH, RTLD_DEEPBIND, RTLD_FIRST, RTLD_GLOBAL, RTLD_LAZY, RTLD_LOCAL,

diff --git a/stdlib/Libdl/test/runtests.jl b/stdlib/Libdl/test/runtests.jl
@@ -331,7 +331,5 @@ end
 end; end
 
 @testset "Docstrings" begin
-    undoc = Docs.undocumented_names(Libdl)
-    @test_broken isempty(undoc)
-    @test undoc == [:Libdl]
+    @test isempty(Docs.undocumented_names(Libdl))
 end