Skip to content

Commit ec0d341

Browse files
authored
Correct the high-level link (#4399)
* Correct the high-level link * Add md pattern * Fix anchor refs * Use EXCLUDE_PATTERNS * Correct ref syntax
1 parent c3b568a commit ec0d341

File tree

5 files changed

+17
-18
lines changed

5 files changed

+17
-18
lines changed

CONTRIBUTING.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,12 @@ around 10 minutes.
1616

1717
## Table of Contents
1818

19-
* [Workflow](#workflow)
20-
* [Acceptance criteria for a pull request](#criteria)
21-
* [Release Note](#releasenote)
22-
* [Check List](#checklist)
19+
* <a href="#workflow">Workflow</a>
20+
* <a href="#criteria">Acceptance criteria for a pull request</a>
21+
* <a href="#releasenote">Release Note</a>
22+
* <a href="#checklist">Check List</a>
2323

24-
# Workflow <A NAME="workflow"></A>
24+
<h2 id="workflow">Workflow</h2>
2525

2626
The process for contributing code to HDF5 is as follows:
2727

@@ -41,7 +41,7 @@ Once a pull request is correctly formatted and passes **ALL** CI tests, it will
4141
community members who can approve pull requests. The HDF Group developers will work with you to ensure that the pull request satisfies the acceptance
4242
criteria described in the next section.
4343

44-
# Acceptance criteria for a pull request <A NAME="criteria"></A>
44+
<h2 id="criteria">Acceptance criteria for a pull request</h2>
4545

4646
We appreciate every contribution we receive, but we may not accept them all. Those that we *do* satisfy the following criteria:
4747

@@ -84,7 +84,7 @@ application developers and not system administrators. Users who may find the REL
8484
application developers, library developers, and system administrators.
8585

8686

87-
# Release Note <A NAME="releasenote"></A>
87+
<h2 id="releasenote">Release Note</h2>
8888

8989
* **Entry Syntax**
9090
The release note entry syntax is shown below.
@@ -112,7 +112,7 @@ You might also consider the following as you describe the solution:
112112
* Is there a workaround – a way for users design their software so as not to encounter the issue? If so, what is the workaround?
113113
* For a performance fix, how has the performance improved? Links to published documentation would be good.
114114

115-
# Checklist <A NAME="checklist"></A>
115+
<h2 id="checklist">Checklist</h2>
116116

117117
Please make sure that you check the items applicable to your pull request:
118118

doxygen/Doxyfile.in

+4-2
Original file line numberDiff line numberDiff line change
@@ -688,6 +688,7 @@ FILE_PATTERNS = H5*public.h H5*module.h H5*develop.h H5FD*.h \
688688
HDF*.java \
689689
*.F90 \
690690
*.dox \
691+
*.md \
691692
H5Cpp.h H5AbstractDs.h H5AtomType.h H5Attribute.h H5CommonFG.h H5CompType.h \
692693
H5DataSet.h H5DataSpace.h H5DataType.h H5OcreatProp.h H5DaccProp.h H5DcreatProp.h \
693694
H5DxferProp.h H5EnumType.h H5Exception.h H5FaccProp.h H5FcreatProp.h H5File.h \
@@ -708,8 +709,7 @@ RECURSIVE = YES
708709
# Note that relative paths are relative to the directory from which doxygen is
709710
# run.
710711

711-
EXCLUDE = examples
712-
712+
EXCLUDE =
713713
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
714714
# directories that are symbolic links (a Unix file system feature) are excluded
715715
# from the input.
@@ -734,6 +734,8 @@ EXCLUDE_PATTERNS += */hl/fortran/test/*
734734
EXCLUDE_PATTERNS += */hl/fortran/src/*.c
735735
EXCLUDE_PATTERNS += */hl/fortran/src/*.h
736736
EXCLUDE_PATTERNS += */HDF5Examples/FORTRAN/*
737+
EXCLUDE_PATTERNS += */sanitizer/*
738+
737739

738740
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
739741
# (namespaces, classes, functions, etc.) that should be excluded from the

doxygen/dox/GettingStarted.dox

+2-2
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,10 @@ Parallel HDF5, and the HDF5-1.10 VDS and SWMR new features:
4242
<table>
4343
<tr>
4444
<td style="background-color:#F5F5F5">
45-
<a href="https://docs.hdfgroup.org/hdf5/develop/high_level.html">Using the High Level APIs</a>
45+
[Using the High Level API](../examples/menus/high_level_menu.md)
4646
</td>
4747
<td>
48-
\ref H5LT \ref H5IM \ref H5TB \ref H5PT \ref H5DS
48+
The high-level HDF5 library includes several sets of convenience and standard-use APIs to facilitate common HDF5 operations.
4949
</td>
5050
</tr>
5151
<tr>

doxygen/examples/menus/high_level_menu.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
<b>High-level library</b>
1+
## High-level Library
2+
23
<br />
34
The high-level HDF5 library includes several sets of convenience and standard-use APIs to
45
facilitate common HDF5 operations.

fortran/src/README.md

+1-5
Original file line numberDiff line numberDiff line change
@@ -109,11 +109,7 @@ FOR DEVELOPERS
109109

110110
The valid KINDs for integers and reals that are stored in H5config_f.inc are used in the H5_buildiface.F90 file located in the fortran/src directory. During the build process, H5_buildiface.F90 generates all the valid F90 KIND interfaces for the following APIs: h5awrite_f, h5aread_f, h5dwrite_f, h5dread_f, h5pset_fill_value_f, h5pget_fill_value_f, h5pset_f, h5pget_f, h5pregister_f, and h5pinsert_f. These APIs can handle up to and including rank seven arrays for all the found KINDs. Again, it's important to note that no new Fortran APIs should be added to H5_buildiface.F90 since new Fortran APIs should not use F90 specification but should instead use F2003. The source file generated by H5_buildiface.F90 is H5_gen.F90, which is the Fortran module H5_GEN, Figure 1. This module is included in the HDF5 module HDF5.F90.
111111

112-
<figure>
113-
<!-- Xfig graphic -->
114-
<img src="./FortBuildFlow.svg">
115-
<figcaption>Figure 1: During the configure and build phases, Fortran files are generated and compiled. This overview explains the flow steps of the build process.</figcaption>
116-
</figure>
112+
![Figure 1: During the configure and build phases, Fortran files are generated and compiled. This overview explains the flow steps of the build process.](./FortBuildFlow.svg)
117113

118114
Procedure to add a new function
119115
--------------------------------

0 commit comments

Comments
 (0)