HDFGroup / HDFGroup/hdf5

Create an HDF5 API -> Doxygen function link lookup service

Open
#5,594 0 comments 0 reactions 1 assignee Assigned to @bmribler View on GitHub
Component - Documentation
Dominant language
C
Stars
988
Forks
355
Avg merge
4d 2h
Merged PRs (30d)
12

Description

Given an HDF5 API, e.g., `H5Screate_simple`, the service would return `group___h5_s.html#ga8e35eea5738b4805856eac7d595254ae` or [`https://support.hdfgroup.org/documentation/hdf5/latest/group___h5_s.html#ga8e35eea5738b4805856eac7d595254ae`](https://support.hdfgroup.org/documentation/hdf5/latest/group___h5_s.html#ga8e35eea5738b4805856eac7d595254ae)

This would remove tedium from the busy lives of external documentation maintainers.

This service is trivial to implement: it would read the [Doxygen tag file](https://github.com/HDFGroup/hdf5/issues/5593) into a dictionary and service requests from that.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.