From 6db70303a27a8523c19232d0ad8c1f1b4d7c5d46 Mon Sep 17 00:00:00 2001 From: Allen Byrne <50328838+byrnHDF@users.noreply.github.com> Date: Tue, 7 Jan 2025 16:47:57 -0600 Subject: [PATCH] Convert IOFlow.html to doxygen (#5207) --- .../{examples/IOFlow.html => dox/IOFlow.dox} | 74 +++++-------------- doxygen/dox/TechnicalNotes.dox | 6 -- 2 files changed, 18 insertions(+), 62 deletions(-) rename doxygen/{examples/IOFlow.html => dox/IOFlow.dox} (69%) diff --git a/doxygen/examples/IOFlow.html b/doxygen/dox/IOFlow.dox similarity index 69% rename from doxygen/examples/IOFlow.html rename to doxygen/dox/IOFlow.dox index b33196d502a..0a2771005fc 100644 --- a/doxygen/examples/IOFlow.html +++ b/doxygen/dox/IOFlow.dox @@ -1,55 +1,20 @@ - - - HDF5 Raw I/O Flow Notes - - - - - - - - -

HDF5 Raw I/O Flow Notes

-

Quincey Koziol
- koziol@ncsa.uiuc.edu
- August 20, 2003 -

- -
    - -

  1. Document's Audience:

    - - - -

  2. Background Reading:

    - -

  3. Introduction:

    - -
    -
    What is this document about?
    -
    This document attempts to supplement the flow charts describing - the flow of control for raw data I/O in the library. -

    -
    - -

  4. Figures:

    -

    The following figures provide the main information:

    - - - - -
    High-Level View of Writing Raw Data
    Perform Serial or Parallel I/O
    Gather/Convert/Scatter
    - -

  5. Notes From Accompanying Figures:

    - -

    This section provides notes to augment the information in the accompanying - figures. -

    +/** \page IOFLOW HDF5 Raw I/O Flow Notes +\li Created by Quincey Koziol, August 20, 2003 +\li Document's Audience: Current H5 library designers and knowledgeable external developers. + +\section sec_ioflow_intro Introduction +What is this document about?
    +This document attempts to supplement the flow charts describing the flow of control for raw data +I/O in the library. +The following figures provide the main information: + + + + +
    High-Level View of Writing Raw Data
    Perform Serial or Parallel I/O
    Gather/Convert/Scatter
    + +\section sec_ioflow_notes Notes From Accompanying Figures +This section provides notes to augment the information in the accompanying figures.
    1. Validate Parameters - Resolve any H5S_ALL parameters @@ -129,8 +94,5 @@
    -
- - +*/ - diff --git a/doxygen/dox/TechnicalNotes.dox b/doxygen/dox/TechnicalNotes.dox index 05961f54162..3cb477561af 100644 --- a/doxygen/dox/TechnicalNotes.dox +++ b/doxygen/dox/TechnicalNotes.dox @@ -18,9 +18,3 @@ */ -/** \page IOFLOW HDF5 Raw I/O Flow Notes - -\htmlinclude IOFlow.html - -*/ -