Commit 33b04d42 authored by Graham, Aaron's avatar Graham, Aaron
Browse files

Fix documentation issues

parent 42e4a206
Pipeline #164020 passed with stage
in 2 minutes and 26 seconds
......@@ -446,37 +446,37 @@ TYPE,EXTENDS(BaseFileType) :: HDF5FileType
!> @copydoc FileType_HDF5::has_attribute
PROCEDURE,PASS :: has_attribute
!> @copybrief FileType_HDF5::write_attribute_st0
!> @copydoc FileType_HDF5_write_attribute_st0
!> @copydoc FileType_HDF5::write_attribute_st0
PROCEDURE,PASS,PRIVATE :: write_attribute_st0
!> @copybrief FileType_HDF5::write_attribute_c0
!> @copydoc FileType_HDF5_write_attribute_c0
!> @copydoc FileType_HDF5::write_attribute_c0
PROCEDURE,PASS,PRIVATE :: write_attribute_c0
!> @copybrief FileType_HDF5::write_attribute_i0
!> @copydoc FileType_HDF5_write_attribute_i0
!> @copydoc FileType_HDF5::write_attribute_i0
PROCEDURE,PASS,PRIVATE :: write_attribute_i0
!> @copybrief FileType_HDF5::write_attribute_d0
!> @copydoc FileType_HDF5_write_attribute_d0
!> @copydoc FileType_HDF5::write_attribute_d0
PROCEDURE,PASS,PRIVATE :: write_attribute_d0
!> @copybrief FileType_HDF5::write_attribute_b0
!> @copydoc FileType_HDF5_write_attribute_b0
!> @copydoc FileType_HDF5::write_attribute_b0
PROCEDURE,PASS,PRIVATE :: write_attribute_b0
!> Generic typebound interface for all @c attribute writes
GENERIC :: write_attribute => write_attribute_st0, write_attribute_c0,&
write_attribute_i0, write_attribute_d0,write_attribute_b0
!> @copybrief FileType_HDF5::read_str_attribure_help
!> @copydoc FileType_HDF5_read_str_attribure_help
!> @copydoc FileType_HDF5::read_str_attribure_help
PROCEDURE,PASS,PRIVATE :: read_attribute_st0
!> @copybrief FileType_HDF5::read_attribute_c0
!> @copydoc FileType_HDF5_read_attribute_c0
!> @copydoc FileType_HDF5::read_attribute_c0
PROCEDURE,PASS,PRIVATE :: read_attribute_c0
!> @copybrief FileType_HDF5::read_attribute_i0
!> @copydoc FileType_HDF5_read_attribute_i0
!> @copydoc FileType_HDF5::read_attribute_i0
PROCEDURE,PASS,PRIVATE :: read_attribute_i0
!> @copybrief FileType_HDF5::read_attribute_d0
!> @copydoc FileType_HDF5_read_attribute_d0
!> @copydoc FileType_HDF5::read_attribute_d0
PROCEDURE,PASS,PRIVATE :: read_attribute_d0
!> @copybrief FileType_HDF5::read_attribute_b0
!> @copydoc FileType_HDF5_read_attribute_b0
!> @copydoc FileType_HDF5::read_attribute_b0
PROCEDURE,PASS,PRIVATE :: read_attribute_b0
!> Generic typebound interface for all @c attribute writes
GENERIC :: read_attribute => read_attribute_st0, read_attribute_c0,&
......@@ -7183,7 +7183,7 @@ ENDSUBROUTINE write_attribute_st0
!
!-------------------------------------------------------------------------------
!> @brief Writes an attribute name and string value to a known dataset
!>
!> @param this the file to read
!> @param obj_name the relative path to the dataset
!> @param attr_name the desired name of the attribute
!> @param attr_value the desired value of the attrbute
......@@ -7202,7 +7202,7 @@ END SUBROUTINE write_attribute_c0
!
!-------------------------------------------------------------------------------
!> @brief Writes an attribute name and integer value to a known dataset
!>
!> @param this the file to read
!> @param obj_name the relative path to the dataset
!> @param attr_name the desired name of the attribute
!> @param attr_value the desired value of the attrbute
......@@ -7239,7 +7239,7 @@ ENDSUBROUTINE write_attribute_i0
!
!-------------------------------------------------------------------------------
!> @brief Writes an attribute name and real value to a known dataset
!>
!> @param this the file to read
!> @param obj_name the relative path to the dataset
!> @param attr_name the desired name of the attribute
!> @param attr_value the desired value of the attrbute
......@@ -7276,7 +7276,7 @@ ENDSUBROUTINE write_attribute_d0
!
!-------------------------------------------------------------------------------
!> @brief Writes an attribute name and logical value to a known dataset
!>
!> @param this the file to read
!> @param obj_name the relative path to the dataset
!> @param attr_name the desired name of the attribute
!> @param attr_value the desired value of the attrbute
......@@ -7302,7 +7302,7 @@ SUBROUTINE write_attribute_b0(this,obj_name,attr_name,attr_val)
CALL h5screate_simple_f(num_dims,dims,dspace_id,error)
!Create and write to the attribute within the dataspce
char_attr_val = MERGE('T','F',attr_val)
char_attr_val = MERGE('T','F',attr_val)
CALL createAttribute(this,obj_id,attr_name,H5T_NATIVE_CHARACTER,&
dspace_id,attr_id)
CALL h5awrite_f(attr_id,H5T_NATIVE_CHARACTER,char_attr_val,dims,error)
......@@ -7315,7 +7315,7 @@ ENDSUBROUTINE write_attribute_b0
!
!-------------------------------------------------------------------------------
!> @brief Set-up to read a string value attribute from a known dataset
!>
!> @param this the file to read
!> @param obj_name the relative path to the dataset
!> @param attr_name the desired name of the attribute
!> @param attr_value the desired value of the attrbute
......@@ -7343,7 +7343,7 @@ ENDSUBROUTINE read_attribute_st0
!
!-------------------------------------------------------------------------------
!> @brief Set-up to read a string value attribute from a known dataset
!>
!> @param this the file to read
!> @param obj_name the relative path to the dataset
!> @param attr_name the desired name of the attribute
!> @param attr_value the desired value of the attrbute
......@@ -7362,7 +7362,7 @@ ENDSUBROUTINE read_attribute_c0
!
!-------------------------------------------------------------------------------
!> @brief Reads a string value attribute from a known dataset
!>
!> @param this the file to read
!> @param obj_name the relative path to the dataset
!> @param attr_name the desired name of the attribute
!> @param attr_value the desired value of the attrbute
......@@ -7386,7 +7386,7 @@ ENDSUBROUTINE read_attribute_st0_helper
!
!-------------------------------------------------------------------------------
!> @brief Reads a integer value attribute from a known dataset
!>
!> @param this the file to read
!> @param obj_name the relative path to the dataset
!> @param attr_name the desired name of the attribute
!> @param attr_value the desired value of the attrbute
......@@ -7419,7 +7419,7 @@ ENDSUBROUTINE read_attribute_i0
!
!-------------------------------------------------------------------------------
!> @brief Reads a double value attribute from a known dataset
!>
!> @param this the file to read
!> @param obj_name the relative path to the dataset
!> @param attr_name the desired name of the attribute
!> @param attr_value the desired value of the attrbute
......@@ -7453,7 +7453,7 @@ ENDSUBROUTINE read_attribute_d0
!
!-------------------------------------------------------------------------------
!> @brief Reads a logical value attribute from a known dataset
!>
!> @param this the file to read
!> @param obj_name the relative path to the dataset
!> @param attr_name the desired name of the attribute
!> @param attr_value the desired value of the attrbute
......@@ -7545,7 +7545,7 @@ ENDSUBROUTINE open_object
!
!-------------------------------------------------------------------------------
!> @brief closes all attribute operations by closing attribute
!>
!> @param this the file to read
!> @param attr_id the HDF5 system id for the working attribute
!> @param obj_id the HDF5 system id for the working object
!>
......@@ -7564,7 +7564,7 @@ ENDSUBROUTINE close_attribute
!
!-------------------------------------------------------------------------------
!> @brief closes all group, dataset, datatype objects
!>
!> @param this the file to read
!> @param attr_id the HDF5 system id for the working attribute
!> @param obj_id the HDF5 system id for the working object
!>
......
......@@ -2285,9 +2285,9 @@ SUBROUTINE testHDF5FileTypeRead()
CALL h5%read_attribute('groupB->memB1',string_name,testST0)
ASSERT_EQ(CHAR(refST0),CHAR(testST0),'string read fail')
CALL h5%read_attribute('groupB->memB1',char_name,testC1)
ASSERT_EQ(refC1,testC1,'string read fail')
ASSERT_EQ(refC1,testC1,'char read fail')
CALL h5%read_attribute('groupB->memB2',real_name,testD0)
ASSERT_EQ(refD0,testD0,'real_read fail')
ASSERT_EQ(refD0,testD0,'real read fail')
COMPONENT_TEST('%fread to parameter list')
CALL h5%fread('groupC',tmpPL)
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment