Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 28 additions & 9 deletions doc/source/api_reference/namespace_dataspace.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,22 +10,21 @@ Dataspace related classes and functions

.. doxygenclass:: hdf5::dataspace::Dataspace
:members:

.. doxygenenum:: hdf5::dataspace::Type



:cpp:class:`Scalar`
-------------------

.. doxygenclass:: hdf5::dataspace::Scalar
:members:

:cpp:class:`Simple`
-------------------

.. doxygenclass:: hdf5::dataspace::Simple
:members:



Selection related classes and functions
=======================================

Expand All @@ -34,13 +33,33 @@ Selection related classes and functions

.. doxygenclass:: hdf5::dataspace::Selection
:members:

.. doxygenenum:: hdf5::dataspace::SelectionType

.. doxygenenum:: hdf5::dataspace::SelectionOperation

:cpp:class:`Hyperslab`
----------------------

.. doxygenclass:: hdf5::dataspace::Hyperslab
:members:

:cpp:class:`Points`
-------------------

.. doxygenclass:: hdf5::dataspace::Points
:members:

Enumerations
============

:cpp:enum:`Type`
----------------

.. doxygenenum:: hdf5::dataspace::Type

:cpp:enum:`SelectionType`
-------------------------

.. doxygenenum:: hdf5::dataspace::SelectionType

:cpp:enum:`SelectionOperation`
------------------------------

.. doxygenenum:: hdf5::dataspace::SelectionOperation
24 changes: 15 additions & 9 deletions doc/source/api_reference/namespace_datatype.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ Enumerations
:cpp:enum:`Class`
-----------------

.. doxygenenum:: hdf5::datatype::Class

.. doxygenfunction:: hdf5::datatype::operator<<(std::ostream &, const Class &)

:cpp:enum:`Order`
Expand Down Expand Up @@ -68,13 +66,13 @@ Classes

.. doxygenclass:: hdf5::datatype::Datatype
:members:

:cpp:class:`Array`
------------------

.. doxygenclass:: hdf5::datatype::Array
:members:

:cpp:class:`VLengthArray`
-------------------------

Expand All @@ -83,25 +81,25 @@ Classes

:cpp:class:`Compound`
---------------------

.. doxygenclass:: hdf5::datatype::Compound
:members:

:cpp:class:`Float`
------------------

.. doxygenclass:: hdf5::datatype::Float
:members:

:cpp:class:`Integer`
--------------------

.. doxygenclass:: hdf5::datatype::Integer
:members:

:cpp:class:`String`
-------------------

.. doxygenclass:: hdf5::datatype::String
:members:

Expand All @@ -110,3 +108,11 @@ Type traits

.. doxygenclass:: hdf5::datatype::TypeTrait
:members:

Enumerations
============

:cpp:enum:`Class`
-----------------

.. doxygenenum:: hdf5::datatype::Class
65 changes: 31 additions & 34 deletions doc/source/api_reference/namespace_node.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,6 @@
Namespace :cpp:any:`hdf5::node`
===============================

Enumerations
============

:cpp:enum:`NodeType`
--------------------

.. doxygenenum:: hdf5::node::NodeType

.. doxygenfunction:: hdf5::node::operator<<(std::ostream &, const NodeType &)

:cpp:enum:`LinkType`
--------------------

.. doxygenenum:: hdf5::node::LinkType

.. doxygenfunction:: hdf5::node::operator<<(std::ostream &, const LinkType &)

Classes
=======

Expand All @@ -37,7 +20,7 @@ Classes

.. doxygenclass:: hdf5::node::Link
:members:

.. doxygenfunction:: hdf5::node::operator!=(const Link &, const Link &)

.. doxygenfunction:: hdf5::node::operator<<(std::ostream &, const Link &)
Expand All @@ -47,63 +30,63 @@ Classes

.. doxygenclass:: hdf5::node::LinkTarget
:members:

:cpp:class:`Group`
------------------

.. doxygenclass:: hdf5::node::Group
:members:

:cpp:class:`GroupView`
----------------------

.. doxygenclass:: hdf5::node::GroupView
:members:

:cpp:class:`NodeView`
---------------------

.. doxygenclass:: hdf5::node::NodeView
:members:

.. doxygenclass:: hdf5::node::NodeIterator
:members:

.. doxygenclass:: hdf5::node::RecursiveNodeIterator
:members:

:cpp:class:`LinkView`
---------------------

.. doxygenclass:: hdf5::node::LinkView
:members:

.. doxygenclass:: hdf5::node::LinkIterator
:members:

.. doxygenclass:: hdf5::node::RecursiveLinkIterator
:members:

:cpp:class:`Dataset`
--------------------

.. doxygenclass:: hdf5::node::Dataset
:members:


:cpp:class:`ChunkedDataset`
---------------------------

.. doxygenclass:: hdf5::node::ChunkedDataset
:members:


:cpp:class:`VirtualDataset`
---------------------------

.. doxygenclass:: hdf5::node::VirtualDataset
:members:

Functions
=========

Expand Down Expand Up @@ -167,5 +150,19 @@ Functions
.. doxygenfunction:: hdf5::node::is_dataset




Enumerations
============

:cpp:enum:`NodeType`
--------------------

.. doxygenenum:: hdf5::node::NodeType

.. doxygenfunction:: hdf5::node::operator<<(std::ostream &, const NodeType &)

:cpp:enum:`LinkType`
--------------------

.. doxygenenum:: hdf5::node::LinkType

.. doxygenfunction:: hdf5::node::operator<<(std::ostream &, const LinkType &)
4 changes: 2 additions & 2 deletions doc/source/users_guide/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -114,12 +114,12 @@ represent the following HDF5 objects:
+-----------------------------------+----------------------------+
| :cpp:class:`hdf5::node::Group` | an HDF5 group |
+-----------------------------------+----------------------------+
| :cpp:class:`hdf5::node::Datatype` | an HDF5 committed datatype |
| :any:`hdf5::node::Datatype` | an HDF5 committed datatype |
+-----------------------------------+----------------------------+

.. important::

Do not confuse :cpp:class:`hdf5::node::Datatype` with
Do not confuse :any:`hdf5::node::Datatype` with
:cpp:class:`hdf5::datatype::Datatype`. Thoug the former one is constructed
from the latter one, the latter one cannot be accessed via a path.
A committed datatype is a means to store complex datatype within a file.
Expand Down