Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

INITIAL attempt at User Guide in doxygen #1678

Merged
merged 159 commits into from
May 13, 2022
Merged

INITIAL attempt at User Guide in doxygen #1678

merged 159 commits into from
May 13, 2022

Conversation

byrnHDF
Copy link
Contributor

@byrnHDF byrnHDF commented Apr 22, 2022

Added UG in main page
Created sections to match order
Added attributes page in H5Amodule.h
Added

  • refs for subsections which are in H5Amodule.h
    Reference manual verbosity reduced; just the functions

    Font sizes are wrong and TOC/navigation is not correct.

    •

    @byrnHDF
    HDFFV-10865 - merge from dev, HDFArray perf fix.
    ebe023d
    @byrnHDF
    Remove duplicate setting
    cc749db
    @byrnHDF
    Merge branch 'hdf5_1_10' of https://github.com/HDFGroup/hdf5.git into…
    5e6ecc2 
    … hdf5_1_10
    @byrnHDF
    Merge branch 'hdf5_1_10' of https://github.com/HDFGroup/hdf5.git into…
    a9227df 
    … hdf5_1_10
    @byrnHDF
    Whitespace changes after clang format
    12c9d1a
    @byrnHDF
    Undo version 11 clang format changes
    55d3565
    @byrnHDF
    Merge branch 'hdf5_1_10' of https://github.com/HDFGroup/hdf5.git into…
    ee4ebd3 
    … hdf5_1_10
    @byrnHDF
    Merge CMake changes from develop
    51e5378
    @byrnHDF
    test testing script merge from develop
    bbc9609
    @byrnHDF
    Update supported platforms
    a8ae83d
    @byrnHDF
    Merge branch 'hdf5_1_10' of https://github.com/HDFGroup/hdf5.git into…
    02f185b 
    … hdf5_1_10
    @byrnHDF
    PR#3 merge from develop
    39d6885
    @byrnHDF
    Merge gcc 10 diagnostics option from develop
    28e5eb4
    @byrnHDF
    Merge branch 'hdf5_1_10' of https://github.com/HDFGroup/hdf5.git into…
    678653c 
    … hdf5_1_10
    @byrnHDF
    Merge #318 OSX changes from develop
    55368fa
    @byrnHDF
    Merge branch 'hdf5_1_10' of https://github.com/HDFGroup/hdf5.git into…
    c74c09c 
    … hdf5_1_10
    @byrnHDF
    Merge small changes from develop
    d8011e2
    @byrnHDF
    Merge branch 'hdf5_1_10' of https://github.com/HDFGroup/hdf5.git into…
    516ac71 
    … hdf5_1_10
    @byrnHDF
    Minor non-space formatting changes
    a6de013
    @byrnHDF
    Merge branch 'hdf5_1_10' of https://github.com/HDFGroup/hdf5.git into…
    4b17412 
    … hdf5_1_10
    @byrnHDF
    Merge branch 'hdf5_1_10' of https://github.com/HDFGroup/hdf5.git into…
    7faebce 
    … hdf5_1_10
    @byrnHDF
    #386 copyright corrections for java folder
    1e21839
    @byrnHDF
    Merge branch 'hdf5_1_10' of https://github.com/HDFGroup/hdf5.git into…
    a80a571 
    … hdf5_1_10
    @byrnHDF
    Merges from develop
    4d7a150 
    #358 patches from vtk
#361 fix header guard spelling
    @byrnHDF
    Merge updates
    e8df4b9 
    #358 patches from vtk
#361 fix header guard spelling
    @byrnHDF
    format fix
    86563f0
    @byrnHDF
    Fix missing underscore and make H5public.h closer to dev
    7fa5973
    @byrnHDF
    Merges from develop
    35e1e68 
    #340 clang -Wformat-security warnings
#360 Fixed uninitialized warnings
header guard underscore cleanup
JNI cleanup
    @byrnHDF
    format alignment
    061da5f
    @byrnHDF
    Add missing test ref file
    4f5536c
    @byrnHDF byrnHDF added documentation WIP Work in progress (please also convert PRs to draft PRs) labels Apr 22, 2022
    @byrnHDF byrnHDF self-assigned this Apr 22, 2022
    @gheber
    Copy link
    Member

    gheber commented Apr 22, 2022 •
    edited
    Loading

    Definitely going in the right direction! We need to work on how to break up the content & navigation, but this is the first step. Can't believe we didn't do this sooner.

    @byrnHDF
    Copy link
    Contributor Author

    byrnHDF commented May 5, 2022

    Added H5E chapter and revised H5A

    @byrnHDF byrnHDF removed the WIP Work in progress (please also convert PRs to draft PRs) label May 5, 2022
    @byrnHDF
    Copy link
    Contributor Author

    byrnHDF commented May 5, 2022

    Beginnig two chapters.

    @byrnHDF byrnHDF mentioned this pull request May 11, 2022
    Merged
    @lrknox
    Copy link
    Collaborator

    lrknox commented May 13, 2022

    Missing checks passed on the initial commit in action https://github.com/HDFGroup/hdf5/actions/runs/2210115566 21 days ago and again on the force-push 8 days ago in action https://github.com/HDFGroup/hdf5/actions/runs/2278452780.

    @lrknox lrknox merged commit 436d691 into HDFGroup:hdf5_1_10 May 13, 2022
    @byrnHDF byrnHDF deleted the hdf5_1_10-UG-doxy branch May 15, 2022 13:22
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @lrknox lrknox lrknox approved these changes

    @jhendersonHDF jhendersonHDF Awaiting requested review from jhendersonHDF jhendersonHDF is a code owner

    @fortnern fortnern Awaiting requested review from fortnern fortnern is a code owner

    @soumagne soumagne Awaiting requested review from soumagne

    @vchoi-hdfgroup vchoi-hdfgroup Awaiting requested review from vchoi-hdfgroup vchoi-hdfgroup is a code owner

    @ChristopherHogan ChristopherHogan Awaiting requested review from ChristopherHogan

    @gnuoyd gnuoyd Awaiting requested review from gnuoyd

    @derobins derobins Awaiting requested review from derobins derobins is a code owner

    @jrmainzer jrmainzer Awaiting requested review from jrmainzer

    Assignees

    @byrnHDF byrnHDF

    Labels
    None yet
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    3 participants
    @byrnHDF @gheber @lrknox