diff options
author | Allen Byrne <50328838+byrnHDF@users.noreply.github.com> | 2021-04-20 00:17:24 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-04-20 00:17:24 (GMT) |
commit | 168c1245b4aa6fa4779b3df5cc050d0272abdc2e (patch) | |
tree | 6e4dc53920a8c2c0bbdb7cfb6f190e6703e80446 /doxygen/dox/rm-template.dox | |
parent | 100e132a62ae1aaf97f379684d04ed00d6016208 (diff) | |
download | hdf5-168c1245b4aa6fa4779b3df5cc050d0272abdc2e.zip hdf5-168c1245b4aa6fa4779b3df5cc050d0272abdc2e.tar.gz hdf5-168c1245b4aa6fa4779b3df5cc050d0272abdc2e.tar.bz2 |
1 8 Merge dev changes for long double and cmake (#548)
* Update supported platforms
* Merge PR#3 changes from develop
* # WARNING: head commit changed in the meantime
Merge gcc 10 diagnostics option from develop
Merge CMake changes from develop
Merge warnings from develop
Merge #318 OSX changes from develop
Merge tools changes from develop
Merge test macros from develop
* Format updates
* Fix missing semicolon and format fix
* Format update
* Correct actions, remove java option
* Update autotools build files
* Add testfiles
* Fix configure issue with make flags
* Init fapls to default
* Update generated files and fix h5repack id closure
* update format
* Merges from develop
#358 patches from vtk
#361 fix header guard spelling
* Merges from develop
#340 clang -Wformat-security warnings
#360 Fixed uninitialized warnings
header guard underscore cleanup
whitespace cleanup
tools sync
* format alignment
* initialize vars
* revert H5private change
* Merge #380 from develop
* Split format source and commit changes on repo push
* Change windows TS to use older VS.
* HDFFV-11229 merge dev changes for long double display in tools
* Committing clang-format changes
* Update unsupported types with precision
Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
Diffstat (limited to 'doxygen/dox/rm-template.dox')
-rw-r--r-- | doxygen/dox/rm-template.dox | 72 |
1 files changed, 72 insertions, 0 deletions
diff --git a/doxygen/dox/rm-template.dox b/doxygen/dox/rm-template.dox new file mode 100644 index 0000000..64e4770 --- /dev/null +++ b/doxygen/dox/rm-template.dox @@ -0,0 +1,72 @@ +/**\ingroup H5XYZ + * + * \brief A synopsis of what H5XYZgreat_function does + * + * \param[in] name1 Description of IN parameter \p name1 + * \param[out] name2 Description of OUT parameter \p name2 + * \param[in,out] name3 Description of INOUT parameter \p name3 + * + * \return Returns what you always wanted + * + * \pre Describe preconditions for an entity. Can be repreated. + * + * \invariant Describe invariants for an entity. Can be repeated. + * + * \post Describe postconditions for an entity. Can be repreated. + * + * \deprecated This was my favorite function while it lasted. + * + * \details Describe the normal behavior flow of the function here. Try to be + * helpful! + * + * Make reference to other functions like this: H5Fopen(). + * + * Make reference to formal parameters like this: \p name1 + * + * Make reference to macros like this: #H5P_DEFAULT. + * + * Make reference to enumeration constants like this: #H5F_CLOSE_WEAK. + * + * Include code snippets like this: + * \snippet H5Zpublic.h H5Z_class2_t_snip + * + * Lists are supported: + * - mouse events + * -# mouse move event + * -# mouse click event\n + * More info about the click event. + * -# mouse double click event + * - keyboard events + * 1. key down event + * 2. key up event + * + * The distance between \f$(x_1,y_1)\f$ and \f$(x_2,y_2)\f$ is + * \f$\sqrt{(x_2-x_1)^2+(y_2-y_1)^2}\f$.\n + * For tables, see + * <a href="https://www.doxygen.nl/manual/tables.html">this example</a>. + * + * This is an example of how to use the H5XYZgreat_function().\n + * The contents of the file hello_hdf5.c will be included. + * \include hello_hdf5.c + * + * \note Dear reader, ... + * + * \attention Colorless green ideas sleep furiously. + * + * \warning Don't do this at home! + * + * \author This function was written by an esteemed author. Repeat this + * command for multiple authors. + * + * \date Record the function's birthdate! + * + * \since 1.MAJOR.MINOR The 'since' command can also be used to record a + * function's introduction (via its initial release + * version). + * + * \version 1.MAJOR.MINOR An important event in the version history of this + * function. There can be multiple such events. + * + * \see H5XYZanother_great_function(), H5XYZnot_so_great_a_function() + * + */ |