# Reference Manual in Doxygen

**URL:** <https://forum.hdfgroup.org/t/reference-manual-in-doxygen/8230>\
**Category:** HDF5 Library\
**Created:** [March 2, 2021, 10:59pm UTC](https://forum.hdfgroup.org/t/reference-manual-in-doxygen/8230 "2021-03-02T22:59:20Z")\
**Posts on this page:** 9\
**Page:** 2

<div class="post-metadata">

**Author:** ![werner](https://forum.hdfgroup.org/letter_avatar_proxy/v4/letter/w/f4b2a3/32.png) [@werner](https://forum.hdfgroup.org/u/werner)\
**Post date:** [August 23, 2021, 9:57am UTC](https://forum.hdfgroup.org/t/reference-manual-in-doxygen/8230/21 "2021-08-23T09:57:39Z")

</div>

The documentation pages in the reference manual for H5Z filter API is referring to an external page with an embedded PDF when talking about “HDF5 Dynamically Loaded Filters”. Can this document be converted into an actual doxygen documentation? It is as important as the H5Z\* functions themselves and deserves the same level of accessibility.

Btw., it looks strange that herr\_t H5Zregister() takes a void\* as argument, but then the documentation specifies the argument needs to be an argument to the H5Z\_class\*\_t structures. Wouldn’t HDF5 benefit from more type-safety in its API?

---

<div class="post-metadata">

**Author:** ![gheber](https://forum.hdfgroup.org/user_avatar/forum.hdfgroup.org/gheber/32/1919_2.png) [@gheber](https://forum.hdfgroup.org/u/gheber)\
**Post date:** [August 24, 2021, 4:39pm UTC](https://forum.hdfgroup.org/t/reference-manual-in-doxygen/8230/22 "2021-08-24T16:39:29Z")

</div>

> [@werner](#):
>
> Can this document be converted into an actual doxygen documentation?

In principle, yes, but I’m not aware of a tool that can produce satisfactory results. To me, using Word & co in this context is like plastic pollution, and I can’t understand what beset The HDF Group to join the polluters. Sigh! Undoing the damage will take time… 😞

> [@werner](#):
>
> Wouldn’t HDF5 benefit from more type-safety in its API?

… and have the compiler take away all the fun? No way! 🕶

G.

---

<div class="post-metadata">

**Author:** ![werner](https://forum.hdfgroup.org/letter_avatar_proxy/v4/letter/w/f4b2a3/32.png) [@werner](https://forum.hdfgroup.org/u/werner)\
**Post date:** [August 25, 2021, 8:07am UTC](https://forum.hdfgroup.org/t/reference-manual-in-doxygen/8230/23 "2021-08-25T08:07:37Z")

</div>

> [@gheber](#):
>
> > [@werner](#):
> >
> > Can this document be converted into an actual doxygen documentation?
> 
> In principle, yes, but I’m not aware of a tool that can produce satisfactory results. To me, using Word & co in this context is like plastic pollution, and I can’t understand what beset The HDF Group to join the polluters. Sigh! Undoing the damage will take time… 😞

It sounds like the right job for the one responsible for that pollution in the first place. After all, the description on how to do filter plugins is even more important than the H5Zregister() call since doing it as plugin is the preferable way, replacing the H5Zregistration() limited to a single application.

> [@gheber](#):
>
> > [@werner](#):
> >
> > Wouldn’t HDF5 benefit from more type-safety in its API?
> 
> … and have the compiler take away all the fun? No way! 🕶

The coding team would be amazed what issues mere compilation of the HDF5 C library as C++ would find… I tried it once, its an interesting experience. 🙂

---

<div class="post-metadata">

**Author:** ![gheber](https://forum.hdfgroup.org/user_avatar/forum.hdfgroup.org/gheber/32/1919_2.png) [@gheber](https://forum.hdfgroup.org/u/gheber)\
**Post date:** [August 27, 2021, 4:33pm UTC](https://forum.hdfgroup.org/t/reference-manual-in-doxygen/8230/24 "2021-08-27T16:33:46Z")

</div>

Two weekend treats:

- The [survey](https://www.hdfgroup.org/website-survey/) is up
- We have [a new RFC](https://docs.hdfgroup.org/hdf5/develop/_r_f_c.html)

I spend my weekends at [https://docs.hdfgroup.org/hdf5/develop/](https://docs.hdfgroup.org/hdf5/develop/) 🕶

G.

---

<div class="post-metadata">

**Author:** ![werner](https://forum.hdfgroup.org/letter_avatar_proxy/v4/letter/w/f4b2a3/32.png) [@werner](https://forum.hdfgroup.org/u/werner)\
**Post date:** [August 30, 2021, 2:14pm UTC](https://forum.hdfgroup.org/t/reference-manual-in-doxygen/8230/25 "2021-08-30T14:14:21Z")

</div>

ah, more PDF’s linked. A good bunch of those RFCs looks outdated and ancient, so that RFC page looks like having optimization potential. But more importantly, if those RFC requests comments, where should and how should they be submitted? Wouldn’t it make most sense to have a dedicated thread in this forum to discuss them and have the documents linking to the respective forum threads?

---

<div class="post-metadata">

**Author:** ![gheber](https://forum.hdfgroup.org/user_avatar/forum.hdfgroup.org/gheber/32/1919_2.png) [@gheber](https://forum.hdfgroup.org/u/gheber)\
**Post date:** [November 19, 2021, 4:08pm UTC](https://forum.hdfgroup.org/t/reference-manual-in-doxygen/8230/26 "2021-11-19T16:08:18Z")

</div>

All, here’s [a take on full-text search](https://docs.hdfgroup.org/hdf5/develop/_f_t_s.html). This is a brute-force complement to what comes with Doxygen out-of-the-box (upper right-hand corner). Let us know what you think! G.

---

<div class="post-metadata">

**Author:** ![gheber](https://forum.hdfgroup.org/user_avatar/forum.hdfgroup.org/gheber/32/1919_2.png) [@gheber](https://forum.hdfgroup.org/u/gheber)\
**Post date:** [November 24, 2021, 12:41am UTC](https://forum.hdfgroup.org/t/reference-manual-in-doxygen/8230/27 "2021-11-24T00:41:45Z")

</div>

Just in time for the 🦃 holidays, we got a boatload of recent RFCs including:

- [Onion VFD](https://docs.hdfgroup.org/hdf5/rfc/Onion_VFD_RFC_211122.pdf)
- [Variable-Length Data in HDF5 Sketch Design](https://docs.hdfgroup.org/hdf5/rfc/var_len_data_sketch_design_190715.pdf)
- [Sparse Chunks](https://docs.hdfgroup.org/hdf5/rfc/RFC_Sparse_Chunks180830.pdf)
- [H5FD\_MIRROR Virtual File Driver](https://docs.hdfgroup.org/hdf5/rfc/mirror_VFD_RFC_2018-10-05.pdf)
- [Splitter\_VFD](https://docs.hdfgroup.org/hdf5/rfc/splitter_VFD_RFC_180830.pdf)

See [RFCs](https://docs.hdfgroup.org/hdf5/develop/_r_f_c.html) for the full listing.

Enjoy! G.

---

<div class="post-metadata">

**Author:** ![werner](https://forum.hdfgroup.org/letter_avatar_proxy/v4/letter/w/f4b2a3/32.png) [@werner](https://forum.hdfgroup.org/u/werner)\
**Post date:** [November 29, 2021, 9:33am UTC](https://forum.hdfgroup.org/t/reference-manual-in-doxygen/8230/28 "2021-11-29T09:33:16Z")

</div>

Are there dedicated forum threads for each RFC that are monitored by the respective VFD authors? Is feedback still considered?

---

<div class="post-metadata">

**Author:** ![gheber](https://forum.hdfgroup.org/user_avatar/forum.hdfgroup.org/gheber/32/1919_2.png) [@gheber](https://forum.hdfgroup.org/u/gheber)\
**Post date:** [November 29, 2021, 10:00pm UTC](https://forum.hdfgroup.org/t/reference-manual-in-doxygen/8230/29 "2021-11-29T22:00:17Z")

</div>

> [@werner](#):
>
> Are there dedicated forum threads for each RFC that are monitored by the respective VFD authors?

No, but nothing, and nobody prevents you from opening such threads.

> [@werner](#):
>
> Is feedback still considered?

Of course. They out here sayin’: “Don’t mess with @werner !” 😀

G.

[Previous page](https://forum.hdfgroup.org/t/reference-manual-in-doxygen/8230.md?page=1)
