more missing docs

JuliaIO · Jan 23, 2023 · 6b86455 · 6b86455
1 parent 4d67028
commit 6b86455
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 11 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -32,6 +32,8 @@ makedocs(;
     pages=[
         "Home" => "index.md",
         "Interface" => [
+            "interface/configuration.md",
+            "interface/files.md",
             "interface/groups.md",
             "interface/dataspaces.md",
             "interface/dataset.md",

diff --git a/docs/src/api_bindings.md b/docs/src/api_bindings.md
@@ -344,6 +344,7 @@ h5l_move
 - [`h5o_get_comment`](@ref h5o_get_comment)
 - [`h5o_get_comment_by_name`](@ref h5o_get_comment_by_name)
 - [`h5o_get_info`](@ref h5o_get_info)
+- [`h5o_get_info1`](@ref h5o_get_info1)
 - [`h5o_get_info_by_idx`](@ref h5o_get_info_by_idx)
 - [`h5o_get_info_by_name`](@ref h5o_get_info_by_name)
 - [`h5o_get_native_info`](@ref h5o_get_native_info)
@@ -374,6 +375,7 @@ h5o_flush
 h5o_get_comment
 h5o_get_comment_by_name
 h5o_get_info
+h5o_get_info1
 h5o_get_info_by_idx
 h5o_get_info_by_name
 h5o_get_native_info

diff --git a/docs/src/interface/filters.md b/docs/src/interface/filters.md
@@ -172,8 +172,13 @@ The filter interface is used to describe filters and obtain information on them.
 ```@docs
 Filter
 FilterPipeline
+UnknownFilter
 FILTERS
+EXTERNAL_FILTER_JULIA_PACKAGES
 filterid
+isavailable
+isdecoderenabled
+isencoderenabled
 encoder_present
 decoder_present
 filtername

diff --git a/gen/gen_wrappers.jl b/gen/gen_wrappers.jl
@@ -15,6 +15,10 @@ Base.remove_linenums!(exprs)
 
 # Definitions which are not automatically generated, but should still be documented as
 # part of the raw low-level API:
+append!(bound_api["H5O"], [
+    # defined in src/api/helpers.jl
+    "h5o_get_info1",
+])
 append!(bound_api["H5P"], [
     # defined in src/api/helpers.jl
     "h5p_get_class_name",

diff --git a/src/api/helpers.jl b/src/api/helpers.jl
@@ -548,13 +548,7 @@ Deprecated HDF5 function. Use [`h5o_get_info`](@ref) or [`h5o_get_native_info`](
 
 See `libhdf5` documentation for [`H5Oget_info1`](https://portal.hdfgroup.org/display/HDF5/H5O_GET_INFO1).
 """
-function h5o_get_info1(object_id, buf)
-    var"#status#" = ccall(
-        (:H5Oget_info1, libhdf5), herr_t, (hid_t, Ptr{H5O_info_t}), object_id, buf
-    )
-    var"#status#" < 0 && @h5error("Error getting object info")
-    return nothing
-end
+h5o_get_info1(object_id, buf) = h5o_get_info()
 function h5o_get_info1(loc_id)
     oinfo = Ref{H5O_info1_t}()
     h5o_get_info1(loc_id, oinfo)

diff --git a/src/drivers/mpio.jl b/src/drivers/mpio.jl
@@ -1,5 +1,6 @@
 using .MPI
 import Libdl
+import HDF5: h5open
 
 ###
 ### MPIO
@@ -96,15 +97,15 @@ support.
 See the [HDF5 docs](https://portal.hdfgroup.org/display/HDF5/H5P_SET_FAPL_MPIO)
 for details on the `comm` and `info` arguments.
 """
-function HDF5.h5open(
+function h5open(
     filename::AbstractString,
     mode::AbstractString,
     comm::MPI.Comm,
     info::MPI.Info=MPI.Info();
     pv...
 )
-    HDF5.h5open(filename, mode; driver=MPIO(comm, info), pv...)
+    h5open(filename, mode; driver=MPIO(comm, info), pv...)
 end
 
-HDF5.h5open(filename::AbstractString, comm::MPI.Comm, args...; pv...) =
-    HDF5.h5open(filename, "r", comm, args...; pv...)
+h5open(filename::AbstractString, comm::MPI.Comm, args...; pv...) =
+    h5open(filename, "r", comm, args...; pv...)