Please, help us to better serve our user community by answering the following short survey: https://www.hdfgroup.org/website-survey/

| HDF 4.3.0 API Reference |

Loading...
Searching...
No Matches
About

# History

The implementation of this documentation set is based on the fantastic work of the Eigen project. Please refer to their GitLab repository and the online version of their Doxygen-based documentation. Not only does Eigen set a standard as a piece of software, but also as an example of documentation done right.

# Documentation about Documentation

In this section, we describe common documentation maintenance tasks.

## Including Plain HTML Pages

The most common use case for this is the inclusion of older documentation. New documentation should, whenever possible, be created using Doxygen markdown!

Use Doxygen's `htmlinclude` special command to include existing plain HTML pages.

An example from this documentation set can be seen here.

## Creating a New Reference Manual Entry

Please refer to the Reference Manual (RM) Page Template for guidance on how to create a new reference manual entry.

## Creating Custom Commands

See Doxygen's Custom Commands documentation as a general reference.

All custom commands for this project are located in the `aliases` file in the `doxygen` subdirectory of the main HDF4 repo.

The custom commands are grouped in sections. Find a suitable section for your command or ask for help if unsure!

## How Do Updates and Changes Get Published?

Currently, the files underlying this documentation website are stored in an bucket on AWS S3. The top-level bucket is

    s3://docs.hdfgroup.org/hdf4/

There are folders for the `development` branch and all supported release version.

Talk to your friendly IT-team if you need write access, or you need someone to push an updated version for you!