From ad40a6548874169b330c67e50db742932c368ba5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=BCrg=20Hutter?= Date: Tue, 13 Mar 2018 17:10:34 +0000 Subject: [PATCH] doxify: use \return for return values (Tiziano Mueller) `\retval` is for documenting specific return values, example: https://github.com/doxygen/doxygen/blob/master/testing/026_exception.cpp While `\return` is for the general return of a function, which is what we intended. And since a function can have only one return value, there is also no need to specify its name. svn-origin-rev: 18316 --- src/acc/acc_device.F | 2 +- src/acc/acc_devmem.F | 8 +- src/acc/acc_event.F | 2 +- src/acc/acc_stream.F | 8 +- src/admm_methods.F | 4 +- src/almo_scf_diis_types.F | 2 +- src/aobasis/ai_eri_debug.F | 2 +- src/aobasis/ai_onecenter.F | 8 +- src/aobasis/ai_overlap3_debug.F | 2 +- src/aobasis/ai_overlap_debug.F | 2 +- src/aobasis/ai_overlap_ppl.F | 4 +- src/aobasis/ao_util.F | 10 +-- src/aobasis/basis_set_container_types.F | 2 +- src/aobasis/basis_set_types.F | 2 +- src/aobasis/orbital_symbols.F | 4 +- src/arnoldi/arnoldi_api.F | 2 +- src/arnoldi/arnoldi_data_methods.F | 10 +-- src/arnoldi/arnoldi_types.F | 28 +++---- src/atom_fit.F | 4 +- src/atom_types.F | 2 +- src/atom_utils.F | 18 ++--- src/base/base_hooks.F | 2 +- src/base/machine.F | 6 +- src/beta_gamma_psi.F | 56 ++++++------- src/bsse.F | 2 +- src/cell_methods.F | 2 +- src/colvar_methods.F | 6 +- src/colvar_utils.F | 4 +- src/common/bessel_lib.F | 14 ++-- src/common/cp_array_utils.F | 2 +- src/common/cp_error_handling.F | 2 +- src/common/cp_files.F | 10 +-- src/common/cp_linked_list.fypp | 12 +-- src/common/cp_log_handling.F | 18 ++--- src/common/cp_min_heap.F | 10 +-- src/common/cp_result_methods.F | 2 +- src/common/cp_units.F | 16 ++-- src/common/dict.F | 10 +-- src/common/dict.fypp | 2 +- src/common/erf_fn.F | 10 +-- src/common/fparser.F | 20 ++--- src/common/gamma.F | 2 +- src/common/glob_matching.F | 2 +- src/common/kahan_sum.F | 66 ++++++++-------- src/common/lebedev.F | 2 +- src/common/list.fypp | 10 +-- src/common/mathlib.F | 44 +++++------ src/common/parallel_rng_types.F | 10 +-- src/common/reference_manager.F | 22 +++--- src/common/spherical_harmonics.F | 30 +++---- src/common/splines.F | 16 ++-- src/common/string_table.F | 8 +- src/common/string_utilities.F | 88 ++++++++++----------- src/common/timings.F | 4 +- src/common/util.F | 4 +- src/common/xml_parser.F | 8 +- src/constraint_clv.F | 4 +- src/cp2k_info.F | 2 +- src/cryssym.F | 2 +- src/csvr_system_utils.F | 4 +- src/d3_poly.F | 32 ++++---- src/dbcsr/base/array_types.F | 14 ++-- src/dbcsr/base/btree.F | 2 +- src/dbcsr/base/dbcsr_methods.F | 72 ++++++++--------- src/dbcsr/base/dbcsr_toollib.F | 10 +-- src/dbcsr/base/hash_table.f90 | 4 +- src/dbcsr/block/dbcsr_index_operations.F | 2 +- src/dbcsr/block/dbcsr_iterator_operations.F | 2 +- src/dbcsr/block/dbcsr_work_operations.F | 4 +- src/dbcsr/data/dbcsr_data_methods_low.F | 36 ++++----- src/dbcsr/data/dbcsr_data_methods_low.f90 | 8 +- src/dbcsr/data/dbcsr_data_types.F | 2 +- src/dbcsr/data/dbcsr_mem_methods.F | 4 +- src/dbcsr/data/dbcsr_ptr_util.F | 2 +- src/dbcsr/data/dbcsr_ptr_util.f90 | 2 +- src/dbcsr/dbcsr_api.F | 32 ++++---- src/dbcsr/dbcsr_api.f90 | 6 +- src/dbcsr/dbcsr_performance_multiply.F | 4 +- src/dbcsr/dbcsr_test_methods.F | 8 +- src/dbcsr/dist/dbcsr_dist_methods.F | 36 ++++----- src/dbcsr/dist/dbcsr_dist_operations.F | 6 +- src/dbcsr/dist/dbcsr_min_heap.F | 10 +-- src/dbcsr/dist/dbcsr_mp_methods.F | 26 +++--- src/dbcsr/dist/dbcsr_mp_operations.F | 4 +- src/dbcsr/dist/dbcsr_util.F | 8 +- src/dbcsr/mm/dbcsr_mm_3d.F | 4 +- src/dbcsr/mm/dbcsr_mm_common.F | 2 +- src/dbcsr/mm/dbcsr_mm_csr.F | 2 +- src/dbcsr/mm/dbcsr_mm_multrec.F | 8 +- src/dbcsr/ops/dbcsr_csr_conversions.F | 2 +- src/dbcsr/ops/dbcsr_operations.F | 18 ++--- src/dbcsr_tensor/array_list_methods.F | 8 +- src/dbcsr_tensor/dbcsr_tensor_block.F | 8 +- src/dbcsr_tensor/dbcsr_tensor_index.F | 12 +-- src/dbcsr_tensor/dbcsr_tensor_reshape.F | 4 +- src/dbcsr_tensor/dbcsr_tensor_test.F | 6 +- src/dbcsr_tensor/dbcsr_tensor_types.F | 6 +- src/dbcsrx/hash_table.f90 | 4 +- src/dm_ls_scf_methods.F | 4 +- src/domain_submatrix_methods.F | 2 +- src/eri_mme/eri_mme_gaussian.F | 2 +- src/eri_mme/eri_mme_lattice_summation.F | 26 +++--- src/eri_mme/eri_mme_util.F | 4 +- src/et_coupling_proj.F | 2 +- src/ewald_environment_types.F | 2 +- src/f77_interface.F | 2 +- src/fm/cp_cfm_basic_linalg.F | 2 +- src/fm/cp_fm_basic_linalg.F | 4 +- src/fm/cp_fm_diag_utils.F | 4 +- src/fm/cp_fm_elpa.F | 6 +- src/fm/cp_fm_pool_types.F | 2 +- src/fm/cp_fm_struct.F | 6 +- src/fm/cp_fm_types.F | 8 +- src/force_env_types.F | 4 +- src/gaussian_gridlevels.F | 2 +- src/graphcon.F | 8 +- src/hfx_communication.F | 2 +- src/hfx_derivatives.F | 2 +- src/hfx_energy_potential.F | 2 +- src/hfx_helpers.F | 2 +- src/hfx_load_balance_methods.F | 10 +-- src/hfx_screening_methods.F | 2 +- src/hfx_types.F | 2 +- src/input/cp_output_handling.F | 12 +-- src/input/cp_parser_inpp_methods.F | 2 +- src/input/cp_parser_methods.F | 12 +-- src/input/input_enumeration_types.F | 4 +- src/input/input_section_types.F | 28 +++---- src/input_cp2k_check.F | 2 +- src/input_cp2k_read.F | 2 +- src/kg_vertex_coloring_methods.F | 2 +- src/kpoint_io.F | 4 +- src/kpoint_transitional.F | 4 +- src/lri_compression.F | 2 +- src/lri_environment_methods.F | 2 +- src/manybody_siepmann.F | 8 +- src/manybody_tersoff.F | 24 +++--- src/mao_methods.F | 2 +- src/metadyn_tools/graph_utils.F | 6 +- src/minimax/minimax_exp_k15.F | 2 +- src/molsym.F | 18 ++--- src/motion/bfgs_optimizer.F | 4 +- src/motion/cg_utils.F | 8 +- src/motion/cp_lbfgs_optimizer_gopt.F | 2 +- src/motion/helium_common.F | 56 ++++++------- src/motion/helium_interactions.F | 18 ++--- src/motion/helium_methods.F | 2 +- src/motion/helium_sampling.F | 4 +- src/motion/helium_worm.F | 10 +-- src/motion/md_conserved_quantities.F | 2 +- src/motion/md_environment_types.F | 2 +- src/motion/md_vel_utils.F | 6 +- src/motion/neb_io.F | 2 +- src/motion/neb_opt_utils.F | 4 +- src/motion/neb_utils.F | 4 +- src/motion/pint_methods.F | 4 +- src/motion/pint_public.F | 4 +- src/mpiwrap/message_passing.F | 8 +- src/mpiwrap/message_passing.f90 | 4 +- src/mscfg_methods.F | 2 +- src/negf_control_types.F | 2 +- src/negf_env_types.F | 2 +- src/negf_integr_utils.F | 4 +- src/negf_matrix_utils.F | 4 +- src/negf_methods.F | 6 +- src/negf_vectors.F | 2 +- src/optimize_basis_utils.F | 2 +- src/optimize_embedding_potential.F | 6 +- src/pair_potential_coulomb.F | 2 +- src/pair_potential_util.F | 4 +- src/pao_input.F | 2 +- src/pao_methods.F | 2 +- src/pao_ml_gaussprocess.F | 4 +- src/pao_param_exp.F | 2 +- src/pexsi_interface.F | 2 +- src/pilaenv_hack.F | 2 +- src/pme_tools.F | 2 +- src/preconditioner_types.F | 2 +- src/pw/cube_utils.F | 6 +- src/pw/dct.F | 8 +- src/pw/dgs.F | 2 +- src/pw/dirichlet_bc_methods.F | 4 +- src/pw/fft/fft_lib.F | 2 +- src/pw/fft/fftw3_lib.F | 2 +- src/pw/pw_grid_info.F | 12 +-- src/pw/pw_grids.F | 2 +- src/pw/pw_methods.F | 10 +-- src/pw/pw_pool_types.F | 2 +- src/pw/pw_spline_utils.F | 6 +- src/pw/realspace_grid_types.F | 4 +- src/pw/rs_methods.F | 2 +- src/qmmm_ff_fist.F | 4 +- src/qmmm_util.F | 6 +- src/qs_active_space_methods.F | 4 +- src/qs_basis_gradient.F | 2 +- src/qs_collocate_density.F | 2 +- src/qs_dftb_matrices.F | 2 +- src/qs_dispersion_pairpot.F | 2 +- src/qs_external_potential.F | 4 +- src/qs_fb_atomic_halo_types.F | 8 +- src/qs_fb_buffer_types.F | 4 +- src/qs_fb_com_tasks_types.F | 4 +- src/qs_fb_distribution_methods.F | 4 +- src/qs_fb_env_types.F | 2 +- src/qs_fb_hash_table_types.F | 6 +- src/qs_fb_matrix_data_types.F | 4 +- src/qs_fb_trial_fns_types.F | 2 +- src/qs_hash_table_functions.F | 4 +- src/qs_integral_utils.F | 8 +- src/qs_kind_types.F | 4 +- src/qs_linres_op.F | 4 +- src/qs_mom_methods.F | 2 +- src/qs_neighbor_list_types.F | 8 +- src/qs_nl_hash_table_types.F | 6 +- src/qs_o3c_types.F | 2 +- src/qs_ot.F | 8 +- src/qs_ot_minimizer.F | 4 +- src/qs_outer_scf.F | 2 +- src/qs_tddfpt2_methods.F | 8 +- src/qs_tddfpt_eigensolver.F | 2 +- src/qs_wf_history_methods.F | 2 +- src/qs_wf_history_types.F | 2 +- src/replica_types.F | 2 +- src/se_core_matrix.F | 4 +- src/semi_empirical_int3_utils.F | 8 +- src/semi_empirical_int_debug.F | 2 +- src/semi_empirical_int_utils.F | 24 +++--- src/semi_empirical_par_utils.F | 12 +-- src/semi_empirical_utils.F | 2 +- src/spglib_f08.F | 18 ++--- src/splines_methods.F | 4 +- src/start/cp2k_runs.F | 2 +- src/start/cp2k_shell.F | 6 +- src/statistical_methods.F | 4 +- src/subsys/atomic_kind_types.F | 2 +- src/subsys/cell_types.F | 10 +-- src/subsys/colvar_types.F | 4 +- src/subsys/particle_types.F | 2 +- src/swarm/glbopt_history.F | 8 +- src/swarm/glbopt_mincrawl.F | 10 +-- src/swarm/glbopt_worker.F | 6 +- src/swarm/swarm_master.F | 2 +- src/swarm/swarm_message.F | 12 +-- src/swarm/swarm_mpi.F | 2 +- src/taper_types.F | 4 +- src/task_list_methods.F | 10 +-- src/tmc/tmc_analysis_types.F | 2 +- src/tmc/tmc_calculations.F | 8 +- src/tmc/tmc_dot_tree.F | 2 +- src/tmc/tmc_file_io.F | 8 +- src/tmc/tmc_messages.F | 2 +- src/tmc/tmc_move_handle.F | 2 +- src/tmc/tmc_moves.F | 4 +- src/tmc/tmc_tree_acceptance.F | 2 +- src/tmc/tmc_tree_search.F | 2 +- src/topology_amber.F | 4 +- src/topology_generate_util.F | 2 +- src/wannier90.F | 2 +- src/xc/cp_linked_list_xc_deriv.F | 2 +- src/xc/xc.F | 2 +- src/xc/xc_b97.F | 2 +- src/xc/xc_derivative_set_types.F | 2 +- src/xc/xc_derivatives.F | 2 +- src/xc/xc_libxc_wrap.F | 4 +- src/xc/xc_rho_cflags_types.F | 2 +- src/xc/xc_xpbe_hole_t_c_lr.F | 12 +-- src/xc/xc_xwpbe.F | 24 +++--- src/xc_pot_saop.F | 8 +- tools/doxify/fixcomments.pl | 39 ++++++--- 269 files changed, 1016 insertions(+), 997 deletions(-) diff --git a/src/acc/acc_device.F b/src/acc/acc_device.F index 46908f21e2..3ae883851d 100644 --- a/src/acc/acc_device.F +++ b/src/acc/acc_device.F @@ -46,7 +46,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Get number of accelerator devices -!> \retval n number of accelerator devices +!> \return number of accelerator devices ! ************************************************************************************************** FUNCTION acc_get_ndevices() RESULT(n) INTEGER :: n diff --git a/src/acc/acc_devmem.F b/src/acc/acc_devmem.F index 918dc53491..17a131cbac 100644 --- a/src/acc/acc_devmem.F +++ b/src/acc/acc_devmem.F @@ -249,7 +249,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Returns a logical, which indicates if the given devmem is allocated. !> \param[in] this device memory -!> \retval res true if device memory is allocated, false otherwise +!> \return true if device memory is allocated, false otherwise !> \author Ole Schuett ! ************************************************************************************************** FUNCTION acc_devmem_allocated(this) RESULT(res) @@ -262,7 +262,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Returns size of given devmem in terms of item count (not bytes!) !> \param[in] this device memory -!> \retval res size of device memory (item count) +!> \return size of device memory (item count) !> \author Ole Schuett ! ************************************************************************************************** FUNCTION acc_devmem_size_in_bytes(this) RESULT(res) @@ -277,7 +277,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Returns C-pointer to data of given devmem. !> \param[in] this device memory -!> \retval res false (accelerator support is not enabled) +!> \return false (accelerator support is not enabled) !> \author Ole Schuett ! ************************************************************************************************** #if ! defined (__ACC) @@ -292,7 +292,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Returns C-pointer to data of given devmem. !> \param[in] this device memory -!> \retval res C-pointer to data of given devmem +!> \return C-pointer to data of given devmem !> \author Ole Schuett ! ************************************************************************************************** FUNCTION acc_devmem_cptr(this) RESULT(res) diff --git a/src/acc/acc_event.F b/src/acc/acc_event.F index f886b1376e..9b3fbcdfe5 100644 --- a/src/acc/acc_event.F +++ b/src/acc/acc_event.F @@ -203,7 +203,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Fortran-wrapper for cudaEventQuery. !> \param[in] this event -!> \retval res true if event has occured, false otherwise +!> \return true if event has occured, false otherwise !> \author Ole Schuett ! ************************************************************************************************** FUNCTION acc_event_query(this) RESULT(res) diff --git a/src/acc/acc_stream.F b/src/acc/acc_stream.F index 3b0776d36d..2feda42dd2 100644 --- a/src/acc/acc_stream.F +++ b/src/acc/acc_stream.F @@ -81,7 +81,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Returns C-pointer of given stream. !> \param[in] this stream ID -!> \retval res false (accelerator support is not enabled) +!> \return false (accelerator support is not enabled) !> \author Ole Schuett ! ************************************************************************************************** #if ! defined (__ACC) @@ -97,7 +97,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Returns C-pointer of given stream. !> \param[in] this stream ID -!> \retval res C-pointer of a given stream +!> \return C-pointer of a given stream !> \author Ole Schuett ! ************************************************************************************************** FUNCTION acc_stream_cptr(this) RESULT(res) @@ -211,7 +211,7 @@ CONTAINS !> \brief Checks if two streams are equal !> \param[in] this first stream !> \param[in] other second stream -!> \retval res true if equal, false otherwise +!> \return true if equal, false otherwise !> \author Ole Schuett ! ************************************************************************************************** FUNCTION acc_stream_equal(this, other) RESULT(res) @@ -229,7 +229,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Checks if a streams is associated !> \param[in] this stream -!> \retval res true if associated, false otherwise +!> \return true if associated, false otherwise !> \author Ole Schuett ! ************************************************************************************************** FUNCTION acc_stream_associated(this) RESULT(res) diff --git a/src/admm_methods.F b/src/admm_methods.F index 266bb863b7..d1572529aa 100644 --- a/src/admm_methods.F +++ b/src/admm_methods.F @@ -2142,7 +2142,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param x ... -!> \retval delta ... +!> \return ... ! ************************************************************************************************** FUNCTION delta(x) REAL(KIND=dp), INTENT(IN) :: x @@ -2159,7 +2159,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param x ... -!> \retval Heaviside ... +!> \return ... ! ************************************************************************************************** FUNCTION Heaviside(x) REAL(KIND=dp), INTENT(IN) :: x diff --git a/src/almo_scf_diis_types.F b/src/almo_scf_diis_types.F index 0de0f1417c..3f9b15f566 100644 --- a/src/almo_scf_diis_types.F +++ b/src/almo_scf_diis_types.F @@ -467,7 +467,7 @@ CONTAINS !> \param B ... !> \param d_A ... !> \param d_B ... -!> \retval almo_scf_diis_error_overlap ... +!> \return ... !> \par History !> 2013.02 created [Rustam Z Khaliullin] !> \author Rustam Z Khaliullin diff --git a/src/aobasis/ai_eri_debug.F b/src/aobasis/ai_eri_debug.F index 6a2965e305..f68be9fac6 100644 --- a/src/aobasis/ai_eri_debug.F +++ b/src/aobasis/ai_eri_debug.F @@ -98,7 +98,7 @@ CONTAINS !> \param cn ... !> \param dn ... !> \param mi ... -!> \retval IABCD ... +!> \return ... ! ************************************************************************************************** RECURSIVE FUNCTION os(an, bn, cn, dn, mi) RESULT(IABCD) INTEGER, DIMENSION(3) :: an, bn, cn, dn diff --git a/src/aobasis/ai_onecenter.F b/src/aobasis/ai_onecenter.F index 731f1b974e..2d13bd637b 100644 --- a/src/aobasis/ai_onecenter.F +++ b/src/aobasis/ai_onecenter.F @@ -653,7 +653,7 @@ CONTAINS !> \brief ... !> \param n ... !> \param x ... -!> \retval v ... +!> \return ... ! ************************************************************************************************** FUNCTION vgau(n, x) RESULT(v) INTEGER, INTENT(IN) :: n @@ -669,7 +669,7 @@ CONTAINS !> \param a ... !> \param b ... !> \param t ... -!> \retval c ... +!> \return ... ! ************************************************************************************************** FUNCTION cgau(a, b, t) RESULT(c) INTEGER, INTENT(IN) :: a, b @@ -873,7 +873,7 @@ CONTAINS !> \brief ... !> \param n ... !> \param x ... -!> \retval v ... +!> \return ... ! ************************************************************************************************** FUNCTION vsto(n, x) RESULT(v) INTEGER, INTENT(IN) :: n @@ -889,7 +889,7 @@ CONTAINS !> \param n ... !> \param m ... !> \param x ... -!> \retval w ... +!> \return ... ! ************************************************************************************************** FUNCTION wsto(n, m, x) RESULT(w) INTEGER, INTENT(IN) :: n, m diff --git a/src/aobasis/ai_overlap3_debug.F b/src/aobasis/ai_overlap3_debug.F index b6c48a0769..7b3dabd18c 100644 --- a/src/aobasis/ai_overlap3_debug.F +++ b/src/aobasis/ai_overlap3_debug.F @@ -76,7 +76,7 @@ CONTAINS !> \param an ... !> \param cn ... !> \param bn ... -!> \retval IACB ... +!> \return ... ! ************************************************************************************************** RECURSIVE FUNCTION os_overlap3(an, cn, bn) RESULT(IACB) INTEGER, DIMENSION(3) :: an, cn, bn diff --git a/src/aobasis/ai_overlap_debug.F b/src/aobasis/ai_overlap_debug.F index 9937b1aa00..21adfa7ab7 100644 --- a/src/aobasis/ai_overlap_debug.F +++ b/src/aobasis/ai_overlap_debug.F @@ -65,7 +65,7 @@ CONTAINS !> \brief ... !> \param an ... !> \param bn ... -!> \retval IAB ... +!> \return ... ! ************************************************************************************************** RECURSIVE FUNCTION os_overlap2(an, bn) RESULT(IAB) INTEGER, DIMENSION(3) :: an, bn diff --git a/src/aobasis/ai_overlap_ppl.F b/src/aobasis/ai_overlap_ppl.F index ad204e0aed..21c4e9bf2d 100644 --- a/src/aobasis/ai_overlap_ppl.F +++ b/src/aobasis/ai_overlap_ppl.F @@ -308,7 +308,7 @@ CONTAINS !> \param nct_ppl ... !> \param alpha_ppl ... !> \param cexp_ppl ... -!> \retval oint ... +!> \return ... ! ************************************************************************************************** FUNCTION ppl_ri_test(rho, ani, rac, nexp_ppl, nct_ppl, alpha_ppl, cexp_ppl) RESULT(oint) REAL(KIND=dp), INTENT(IN) :: rho @@ -452,7 +452,7 @@ CONTAINS !> \brief ... !> \param n ... !> \param k ... -!> \retval choose ... +!> \return ... ! ************************************************************************************************** FUNCTION choose(n, k) diff --git a/src/aobasis/ao_util.F b/src/aobasis/ao_util.F index 21790d0eda..8b90e96c87 100644 --- a/src/aobasis/ao_util.F +++ b/src/aobasis/ao_util.F @@ -107,7 +107,7 @@ CONTAINS !> \param radius ... !> \param threshold ... !> \param prefactor ... -!> \retval exponent ... +!> \return ... !> \date 07.03.1999 !> \par Variables !> - exponent : Exponent of the primitive Gaussian function. @@ -143,7 +143,7 @@ CONTAINS !> \param prefactor Prefactor of the Gaussian function (e.g. a contraction !> coefficient). !> \param epsin Convergence criterion -!> \retval radius Calculated radius of the Gaussian functio +!> \return Calculated radius of the Gaussian functio !> \date 26.02.1999 !> \par History !> - Modified to bisection to avoid division by zero (01.2002, Joost) @@ -266,7 +266,7 @@ CONTAINS !> \param prefactor ... !> \param cutoff ... !> \param epsin ... -!> \retval radius ... +!> \return ... !> \par History !> 03.2007 new version that assumes that the Gaussians origante from spherical !> Gaussians @@ -362,7 +362,7 @@ CONTAINS !> \brief ... !> \param alpha ... !> \param l ... -!> \retval gaussint_sph ... +!> \return ... ! ************************************************************************************************** FUNCTION gaussint_sph(alpha, l) @@ -394,7 +394,7 @@ CONTAINS !> \param ldb ... !> \param m ... !> \param n ... -!> \retval trace_r_AxB ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION trace_r_AxB(A, lda, B, ldb, m, n) diff --git a/src/aobasis/basis_set_container_types.F b/src/aobasis/basis_set_container_types.F index 41bc2b2293..b72bf29ade 100644 --- a/src/aobasis/basis_set_container_types.F +++ b/src/aobasis/basis_set_container_types.F @@ -82,7 +82,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param basis_set_type ... -!> \retval basis_type_nr ... +!> \return ... ! ************************************************************************************************** FUNCTION get_basis_type(basis_set_type) RESULT(basis_type_nr) CHARACTER(len=*) :: basis_set_type diff --git a/src/aobasis/basis_set_types.F b/src/aobasis/basis_set_types.F index 1f7d89ca43..8f900084f8 100644 --- a/src/aobasis/basis_set_types.F +++ b/src/aobasis/basis_set_types.F @@ -2363,7 +2363,7 @@ CONTAINS !> \param ne ... !> \param n ... !> \param l ... -!> \retval srules ... +!> \return ... ! ************************************************************************************************** FUNCTION srules(z, ne, n, l) ! Slater rules diff --git a/src/aobasis/orbital_symbols.F b/src/aobasis/orbital_symbols.F index e68a221eb4..00b5703c96 100644 --- a/src/aobasis/orbital_symbols.F +++ b/src/aobasis/orbital_symbols.F @@ -33,7 +33,7 @@ CONTAINS !> \brief Build a Cartesian orbital symbol (orbital labels for printing). !> \param n ... !> \param lxyz ... -!> \retval symbol ... +!> \return ... !> \date 07.07.99 !> \author Matthias Krack !> \version 1.0 @@ -91,7 +91,7 @@ CONTAINS !> \param n ... !> \param l ... !> \param m ... -!> \retval symbol ... +!> \return ... !> \date 11.03.99 !> \par Variables !> - l: Angular momentum quantum number l of the orbital. diff --git a/src/arnoldi/arnoldi_api.F b/src/arnoldi/arnoldi_api.F index 99db3fcb89..fa6bf0560d 100644 --- a/src/arnoldi/arnoldi_api.F +++ b/src/arnoldi/arnoldi_api.F @@ -510,7 +510,7 @@ CONTAINS !> \param avec ... !> \param bvec ... !> \param mpgrp ... -!> \retval adotb ... +!> \return ... ! ************************************************************************************************** FUNCTION vec_dot_vec(avec, bvec, mpgrp) RESULT(adotb) TYPE(dbcsr_type) :: avec, bvec diff --git a/src/arnoldi/arnoldi_data_methods.F b/src/arnoldi/arnoldi_data_methods.F index bb5b315ef3..777e9b6e94 100644 --- a/src/arnoldi/arnoldi_data_methods.F +++ b/src/arnoldi/arnoldi_data_methods.F @@ -250,7 +250,7 @@ CONTAINS ! ************************************************************************************************** !> \brief returns the number of restarts allowed for arnoldi !> \param arnoldi_data ... -!> \retval nrestart ... +!> \return ... ! ************************************************************************************************** FUNCTION get_nrestart(arnoldi_data) RESULT(nrestart) TYPE(arnoldi_data_type) :: arnoldi_data @@ -266,7 +266,7 @@ CONTAINS ! ************************************************************************************************** !> \brief get the number of eigenvalues matching the search criterion !> \param ar_data ... -!> \retval nval_out ... +!> \return ... ! ************************************************************************************************** FUNCTION get_nval_out(ar_data) RESULT(nval_out) TYPE(arnoldi_data_type) :: ar_data @@ -283,7 +283,7 @@ CONTAINS !> \brief get the dimension of the krylov space. Can be less than max_iter !> if subspace converged early !> \param ar_data ... -!> \retval current_step ... +!> \return ... ! ************************************************************************************************** FUNCTION get_subsp_size(ar_data) RESULT(current_step) TYPE(arnoldi_data_type) :: ar_data @@ -299,7 +299,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Find out whether the method with the current search criterion is converged !> \param ar_data ... -!> \retval converged ... +!> \return ... ! ************************************************************************************************** FUNCTION arnoldi_is_converged(ar_data) RESULT(converged) TYPE(arnoldi_data_type) :: ar_data @@ -316,7 +316,7 @@ CONTAINS !> \brief get a single specific Ritz value from the set of selected !> \param ar_data ... !> \param ind ... -!> \retval eval_out ... +!> \return ... ! ************************************************************************************************** FUNCTION get_selected_ritz_val(ar_data, ind) RESULT(eval_out) TYPE(arnoldi_data_type) :: ar_data diff --git a/src/arnoldi/arnoldi_types.F b/src/arnoldi/arnoldi_types.F index 74a7457823..95a1121ad4 100644 --- a/src/arnoldi/arnoldi_types.F +++ b/src/arnoldi/arnoldi_types.F @@ -118,7 +118,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param ar_data ... -!> \retval selected_ind ... +!> \return ... ! ************************************************************************************************** FUNCTION get_sel_ind(ar_data) RESULT(selected_ind) TYPE(arnoldi_data_type) :: ar_data @@ -131,7 +131,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param ar_data ... -!> \retval data_d ... +!> \return ... ! ************************************************************************************************** FUNCTION get_data_d(ar_data) RESULT(data_d) TYPE(arnoldi_data_type) :: ar_data @@ -144,7 +144,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param ar_data ... -!> \retval data_s ... +!> \return ... ! ************************************************************************************************** FUNCTION get_data_s(ar_data) RESULT(data_s) TYPE(arnoldi_data_type) :: ar_data @@ -157,7 +157,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param ar_data ... -!> \retval data_z ... +!> \return ... ! ************************************************************************************************** FUNCTION get_data_z(ar_data) RESULT(data_z) TYPE(arnoldi_data_type) :: ar_data @@ -170,7 +170,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param ar_data ... -!> \retval data_c ... +!> \return ... ! ************************************************************************************************** FUNCTION get_data_c(ar_data) RESULT(data_c) TYPE(arnoldi_data_type) :: ar_data @@ -235,7 +235,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param ar_data ... -!> \retval control ... +!> \return ... ! ************************************************************************************************** FUNCTION get_control(ar_data) RESULT(control) TYPE(arnoldi_data_type) :: ar_data @@ -248,7 +248,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param ar_data ... -!> \retval is_present ... +!> \return ... ! ************************************************************************************************** FUNCTION has_d_real(ar_data) RESULT(is_present) TYPE(arnoldi_data_type) :: ar_data @@ -261,7 +261,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param ar_data ... -!> \retval is_present ... +!> \return ... ! ************************************************************************************************** FUNCTION has_s_real(ar_data) RESULT(is_present) TYPE(arnoldi_data_type) :: ar_data @@ -274,7 +274,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param ar_data ... -!> \retval is_present ... +!> \return ... ! ************************************************************************************************** FUNCTION has_d_cmplx(ar_data) RESULT(is_present) TYPE(arnoldi_data_type) :: ar_data @@ -287,7 +287,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param ar_data ... -!> \retval is_present ... +!> \return ... ! ************************************************************************************************** FUNCTION has_s_cmplx(ar_data) RESULT(is_present) TYPE(arnoldi_data_type) :: ar_data @@ -300,7 +300,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param ar_data ... -!> \retval evals ... +!> \return ... ! ************************************************************************************************** FUNCTION get_evals_d(ar_data) RESULT(evals) TYPE(arnoldi_data_type) :: ar_data @@ -313,7 +313,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param ar_data ... -!> \retval evals ... +!> \return ... ! ************************************************************************************************** FUNCTION get_evals_s(ar_data) RESULT(evals) TYPE(arnoldi_data_type) :: ar_data @@ -326,7 +326,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param ar_data ... -!> \retval evals ... +!> \return ... ! ************************************************************************************************** FUNCTION get_evals_z(ar_data) RESULT(evals) TYPE(arnoldi_data_type) :: ar_data @@ -339,7 +339,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param ar_data ... -!> \retval evals ... +!> \return ... ! ************************************************************************************************** FUNCTION get_evals_c(ar_data) RESULT(evals) TYPE(arnoldi_data_type) :: ar_data diff --git a/src/atom_fit.F b/src/atom_fit.F index e9c4d9ce1d..c02797c0d0 100644 --- a/src/atom_fit.F +++ b/src/atom_fit.F @@ -1502,7 +1502,7 @@ CONTAINS !> \brief ... !> \param fval ... !> \param ftarget ... -!> \retval errval ... +!> \return ... ! ************************************************************************************************** FUNCTION get_error_value(fval, ftarget) RESULT(errval) REAL(KIND=dp), INTENT(in) :: fval, ftarget @@ -1681,7 +1681,7 @@ CONTAINS !> \brief ... !> \param id ... !> \param xval ... -!> \retval yval ... +!> \return ... ! ************************************************************************************************** FUNCTION rcpro(id, xval) RESULT(yval) INTEGER, INTENT(IN) :: id diff --git a/src/atom_types.F b/src/atom_types.F index 287550728e..29c4461302 100644 --- a/src/atom_types.F +++ b/src/atom_types.F @@ -2868,7 +2868,7 @@ CONTAINS !> \brief ... !> \param grid1 ... !> \param grid2 ... -!> \retval is_equal ... +!> \return ... ! ************************************************************************************************** FUNCTION atom_compare_grids(grid1, grid2) RESULT(is_equal) TYPE(grid_atom_type) :: grid1, grid2 diff --git a/src/atom_utils.F b/src/atom_utils.F index f3a2c25bc2..9bbe269eae 100644 --- a/src/atom_utils.F +++ b/src/atom_utils.F @@ -270,7 +270,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param occupation ... -!> \retval maxl ... +!> \return ... ! ************************************************************************************************** FUNCTION get_maxl_occ(occupation) RESULT(maxl) REAL(Kind=dp), DIMENSION(0:lmat, 10) :: occupation @@ -288,7 +288,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param occupation ... -!> \retval maxn ... +!> \return ... ! ************************************************************************************************** FUNCTION get_maxn_occ(occupation) RESULT(maxn) REAL(Kind=dp), DIMENSION(0:lmat, 10) :: occupation @@ -985,7 +985,7 @@ CONTAINS !> \brief ... !> \param fun ... !> \param deps ... -!> \retval nc ... +!> \return ... ! ************************************************************************************************** FUNCTION prune_grid(fun, deps) RESULT(nc) REAL(KIND=dp), DIMENSION(:), INTENT(IN) :: fun @@ -1012,7 +1012,7 @@ CONTAINS !> \brief ... !> \param fun ... !> \param grid ... -!> \retval integral ... +!> \return ... ! ************************************************************************************************** FUNCTION integrate_grid_function1(fun, grid) RESULT(integral) REAL(KIND=dp), DIMENSION(:), INTENT(IN) :: fun @@ -1031,7 +1031,7 @@ CONTAINS !> \param fun1 ... !> \param fun2 ... !> \param grid ... -!> \retval integral ... +!> \return ... ! ************************************************************************************************** FUNCTION integrate_grid_function2(fun1, fun2, grid) RESULT(integral) REAL(KIND=dp), DIMENSION(:), INTENT(IN) :: fun1, fun2 @@ -1051,7 +1051,7 @@ CONTAINS !> \param fun2 ... !> \param fun3 ... !> \param grid ... -!> \retval integral ... +!> \return ... ! ************************************************************************************************** FUNCTION integrate_grid_function3(fun1, fun2, fun3, grid) RESULT(integral) REAL(KIND=dp), DIMENSION(:), INTENT(IN) :: fun1, fun2, fun3 @@ -1605,7 +1605,7 @@ CONTAINS !> \brief ... !> \param opmat ... !> \param pmat ... -!> \retval trace ... +!> \return ... ! ************************************************************************************************** FUNCTION atom_trace(opmat, pmat) RESULT(trace) REAL(KIND=dp), DIMENSION(:, :, 0:), INTENT(IN) :: opmat, pmat @@ -1935,7 +1935,7 @@ CONTAINS !> \brief ... !> \param method ... !> \param multiplicity ... -!> \retval consistent ... +!> \return ... ! ************************************************************************************************** FUNCTION atom_consistent_method(method, multiplicity) RESULT(consistent) INTEGER, INTENT(IN) :: method, multiplicity @@ -1961,7 +1961,7 @@ CONTAINS !> \brief ... !> \param atom ... !> \param rho0 ... -!> \retval nc ... +!> \return ... ! ************************************************************************************************** SUBROUTINE get_rho0(atom, rho0) TYPE(atom_type), INTENT(IN) :: atom diff --git a/src/base/base_hooks.F b/src/base/base_hooks.F index e46701a512..9213deae73 100644 --- a/src/base/base_hooks.F +++ b/src/base/base_hooks.F @@ -176,7 +176,7 @@ CONTAINS !> \brief Helper routine to assemble __LOCATION__ !> \param filename ... !> \param lineNr ... -!> \retval location ... +!> \return ... !> \author Ole Schuett ! ************************************************************************************************** FUNCTION cp__l(filename, lineNr) RESULT(location) diff --git a/src/base/machine.F b/src/base/machine.F index b6ca54f32f..6d62233043 100644 --- a/src/base/machine.F +++ b/src/base/machine.F @@ -62,7 +62,7 @@ END SUBROUTINE ! ************************************************************************************************** !> \brief returns time from a real-time clock, protected against rolling !> early/easily -!> \retval wt ... +!> \return ... !> \par History !> 03.2006 created [Joost VandeVondele] !> \note @@ -151,7 +151,7 @@ END SUBROUTINE m_cpuinfo !> \brief returns the energy used since some time in the past. !> The precise meaning depends on the infrastructure is available. !> In the cray_pm_energy case, this is the energy used by the node in kJ. -!> \retval wt ... +!> \return ... !> \par History !> 09.2013 created [Joost VandeVondele, Ole Schuett] ! ************************************************************************************************** @@ -172,7 +172,7 @@ END FUNCTION m_energy ! ************************************************************************************************** !> \brief reads energy values from the sys-filesystem !> \param filename ... -!> \retval wt ... +!> \return ... !> \par History !> 09.2013 created [Joost VandeVondele, Ole Schuett] ! ************************************************************************************************** diff --git a/src/beta_gamma_psi.F b/src/beta_gamma_psi.F index 50e335ae8e..8fb2082cd9 100644 --- a/src/beta_gamma_psi.F +++ b/src/beta_gamma_psi.F @@ -21,7 +21,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param i ... -!> \retval fn_val ... +!> \return ... ! ************************************************************************************************** FUNCTION ipmpar (i) RESULT(fn_val) !----------------------------------------------------------------------- @@ -108,7 +108,7 @@ END FUNCTION ipmpar ! ************************************************************************************************** !> \brief ... !> \param i ... -!> \retval fn_val ... +!> \return ... ! ************************************************************************************************** FUNCTION dpmpar (i) RESULT(fn_val) !----------------------------------------------------------------------- @@ -146,7 +146,7 @@ END FUNCTION dpmpar ! ************************************************************************************************** !> \brief ... -!> \retval fn_val ... +!> \return ... ! ************************************************************************************************** FUNCTION epsln () RESULT(fn_val) !-------------------------------------------------------------------- @@ -166,7 +166,7 @@ END FUNCTION epsln ! ************************************************************************************************** !> \brief ... !> \param l ... -!> \retval fn_val ... +!> \return ... ! ************************************************************************************************** FUNCTION exparg (l) RESULT(fn_val) !-------------------------------------------------------------------- @@ -195,7 +195,7 @@ END FUNCTION exparg ! ************************************************************************************************** !> \brief ... -!> \retval fn_val ... +!> \return ... ! ************************************************************************************************** FUNCTION depsln () RESULT(fn_val) !-------------------------------------------------------------------- @@ -215,7 +215,7 @@ END FUNCTION depsln ! ************************************************************************************************** !> \brief ... !> \param l ... -!> \retval fn_val ... +!> \return ... ! ************************************************************************************************** FUNCTION dxparg (l) RESULT(fn_val) !-------------------------------------------------------------------- @@ -245,7 +245,7 @@ END FUNCTION dxparg ! ************************************************************************************************** !> \brief ... !> \param a ... -!> \retval fn_val ... +!> \return ... ! ************************************************************************************************** FUNCTION alnrel(a) RESULT(fn_val) !----------------------------------------------------------------------- @@ -279,7 +279,7 @@ END FUNCTION alnrel ! ************************************************************************************************** !> \brief ... !> \param x ... -!> \retval fn_val ... +!> \return ... ! ************************************************************************************************** FUNCTION erf1(x) RESULT(fn_val) !----------------------------------------------------------------------- @@ -340,7 +340,7 @@ END FUNCTION erf1 !> \brief ... !> \param ind ... !> \param x ... -!> \retval fn_val ... +!> \return ... ! ************************************************************************************************** FUNCTION erfc1 (ind, x) RESULT(fn_val) !----------------------------------------------------------------------- @@ -426,7 +426,7 @@ END FUNCTION erfc1 ! ************************************************************************************************** !> \brief ... !> \param a ... -!> \retval fn_val ... +!> \return ... ! ************************************************************************************************** FUNCTION gam1(a) RESULT(fn_val) !----------------------------------------------------------------------- @@ -480,7 +480,7 @@ END FUNCTION gam1 !> \brief ... !> \param a ... !> \param b ... -!> \retval fn_val ... +!> \return ... ! ************************************************************************************************** FUNCTION algdiv (a, b) RESULT(fn_val) !----------------------------------------------------------------------- @@ -545,7 +545,7 @@ END FUNCTION algdiv ! ************************************************************************************************** !> \brief ... !> \param x ... -!> \retval fn_val ... +!> \return ... ! ************************************************************************************************** FUNCTION rexp (x) RESULT(fn_val) !----------------------------------------------------------------------- @@ -798,7 +798,7 @@ END SUBROUTINE grat1 !> \brief ... !> \param mu ... !> \param x ... -!> \retval fn_val ... +!> \return ... ! ************************************************************************************************** FUNCTION esum (mu, x) RESULT(fn_val) !----------------------------------------------------------------------- @@ -833,7 +833,7 @@ END FUNCTION esum ! ************************************************************************************************** !> \brief ... !> \param x ... -!> \retval fn_val ... +!> \return ... ! ************************************************************************************************** FUNCTION rlog1(x) RESULT(fn_val) !----------------------------------------------------------------------- @@ -886,7 +886,7 @@ END FUNCTION rlog1 ! ************************************************************************************************** !> \brief ... !> \param a ... -!> \retval fn_val ... +!> \return ... ! ************************************************************************************************** FUNCTION gamln (a) RESULT(fn_val) !----------------------------------------------------------------------- @@ -933,7 +933,7 @@ END FUNCTION gamln ! ************************************************************************************************** !> \brief ... !> \param a ... -!> \retval fn_val ... +!> \return ... ! ************************************************************************************************** FUNCTION gamln1 (a) RESULT(fn_val) !----------------------------------------------------------------------- @@ -971,7 +971,7 @@ END FUNCTION gamln1 ! ************************************************************************************************** !> \brief ... !> \param xx ... -!> \retval fn_val ... +!> \return ... ! ************************************************************************************************** FUNCTION psi(xx) RESULT(fn_val) !--------------------------------------------------------------------- @@ -1156,7 +1156,7 @@ END FUNCTION psi !> \brief ... !> \param a0 ... !> \param b0 ... -!> \retval fn_val ... +!> \return ... ! ************************************************************************************************** FUNCTION betaln (a0, b0) RESULT(fn_val) !----------------------------------------------------------------------- @@ -1263,7 +1263,7 @@ END FUNCTION betaln !> \brief ... !> \param a ... !> \param b ... -!> \retval fn_val ... +!> \return ... ! ************************************************************************************************** FUNCTION gsumln (a, b) RESULT(fn_val) !----------------------------------------------------------------------- @@ -1289,7 +1289,7 @@ END FUNCTION gsumln !> \brief ... !> \param a0 ... !> \param b0 ... -!> \retval fn_val ... +!> \return ... ! ************************************************************************************************** FUNCTION bcorr (a0, b0) RESULT(fn_val) !----------------------------------------------------------------------- @@ -1575,7 +1575,7 @@ END SUBROUTINE bratio !> \param b ... !> \param x ... !> \param eps ... -!> \retval fn_val ... +!> \return ... ! ************************************************************************************************** FUNCTION fpser (a, b, x, eps) RESULT(fn_val) !----------------------------------------------------------------------- @@ -1629,7 +1629,7 @@ END FUNCTION fpser !> \param b ... !> \param x ... !> \param eps ... -!> \retval fn_val ... +!> \return ... ! ************************************************************************************************** FUNCTION apser (a, b, x, eps) RESULT(fn_val) !----------------------------------------------------------------------- @@ -1675,7 +1675,7 @@ END FUNCTION apser !> \param b ... !> \param x ... !> \param eps ... -!> \retval fn_val ... +!> \return ... ! ************************************************************************************************** FUNCTION bpser (a, b, x, eps) RESULT(fn_val) !----------------------------------------------------------------------- @@ -1777,7 +1777,7 @@ END FUNCTION bpser !> \param y ... !> \param n ... !> \param eps ... -!> \retval fn_val ... +!> \return ... ! ************************************************************************************************** FUNCTION bup (a, b, x, y, n, eps) RESULT(fn_val) !----------------------------------------------------------------------- @@ -1873,7 +1873,7 @@ END FUNCTION bup !> \param y ... !> \param lambda ... !> \param eps ... -!> \retval fn_val ... +!> \return ... ! ************************************************************************************************** FUNCTION bfrac (a, b, x, y, lambda, eps) RESULT(fn_val) !----------------------------------------------------------------------- @@ -1953,7 +1953,7 @@ END FUNCTION bfrac !> \param b ... !> \param x ... !> \param y ... -!> \retval fn_val ... +!> \return ... ! ************************************************************************************************** FUNCTION brcomp (a, b, x, y) RESULT(fn_val) !----------------------------------------------------------------------- @@ -2093,7 +2093,7 @@ END FUNCTION brcomp !> \param b ... !> \param x ... !> \param y ... -!> \retval fn_val ... +!> \return ... ! ************************************************************************************************** FUNCTION brcmp1 (mu, a, b, x, y) RESULT(fn_val) !----------------------------------------------------------------------- @@ -2228,7 +2228,7 @@ END FUNCTION brcmp1 !> \param b ... !> \param lambda ... !> \param eps ... -!> \retval fn_val ... +!> \return ... ! ************************************************************************************************** FUNCTION basym (a, b, lambda, eps) RESULT(fn_val) !----------------------------------------------------------------------- diff --git a/src/bsse.F b/src/bsse.F index f216b20f41..2adf471b0a 100644 --- a/src/bsse.F +++ b/src/bsse.F @@ -571,7 +571,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param num ... -!> \retval my_fact ... +!> \return ... ! ************************************************************************************************** RECURSIVE FUNCTION FACT(num) RESULT(my_fact) INTEGER, INTENT(IN) :: num diff --git a/src/cell_methods.F b/src/cell_methods.F index eb2f409ef6..7b640b0305 100644 --- a/src/cell_methods.F +++ b/src/cell_methods.F @@ -194,7 +194,7 @@ CONTAINS !> returns true if the new input was parsed !> \param input_file the parsed input file !> \param check_this_section ... -!> \retval res ... +!> \return ... !> \author fawzi ! ************************************************************************************************** FUNCTION parsed_cp2k_input(input_file, check_this_section) RESULT(res) diff --git a/src/colvar_methods.F b/src/colvar_methods.F index bd099b71ce..629934adea 100644 --- a/src/colvar_methods.F +++ b/src/colvar_methods.F @@ -5813,7 +5813,7 @@ CONTAINS !> \param lambda ... !> \param ifunc ... !> \param nconf ... -!> \retval k ... +!> \return ... !> \author fschiff ! ************************************************************************************************** RECURSIVE FUNCTION rec_eval_grid(iw1, ncol, f_vals, v_count, & @@ -6046,7 +6046,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param rij ... -!> \retval distance ... +!> \return ... ! ************************************************************************************************** REAL(dp) FUNCTION distance(rij) REAL(dp), INTENT(in) :: rij(3) @@ -6166,7 +6166,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param rij ... -!> \retval distance ... +!> \return ... ! ************************************************************************************************** REAL(dp) FUNCTION distance(rij) REAL(dp), INTENT(in) :: rij(3) diff --git a/src/colvar_utils.F b/src/colvar_utils.F index 0055cfa5e6..49b0f78ae5 100644 --- a/src/colvar_utils.F +++ b/src/colvar_utils.F @@ -62,7 +62,7 @@ CONTAINS !> \param force_env ... !> \param only_intra_colvar ... !> \param unique ... -!> \retval ntot ... +!> \return ... !> \author Teodoro Laino 05.2007 [tlaino] - Zurich University ! ************************************************************************************************** FUNCTION number_of_colvar(force_env, only_intra_colvar, unique) RESULT(ntot) @@ -333,7 +333,7 @@ CONTAINS !> \brief Computes the offset of the colvar for the specific molecule !> \param i ... !> \param molecule_set ... -!> \retval offset ... +!> \return ... !> \author Teodoro Laino 05.2007 [tlaino] - Zurich University ! ************************************************************************************************** FUNCTION get_colvar_offset(i, molecule_set) RESULT(offset) diff --git a/src/common/bessel_lib.F b/src/common/bessel_lib.F index 1b4c689d57..45fe2fd8ee 100644 --- a/src/common/bessel_lib.F +++ b/src/common/bessel_lib.F @@ -28,7 +28,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param x ... -!> \retval bessj0 ... +!> \return ... ! ************************************************************************************************** FUNCTION bessj0(x) @@ -66,7 +66,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param x ... -!> \retval bessj1 ... +!> \return ... ! ************************************************************************************************** FUNCTION bessj1(x) @@ -103,7 +103,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param x must be positive -!> \retval bessk0 ... +!> \return ... ! ************************************************************************************************** FUNCTION bessk0(x) @@ -132,7 +132,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param x must be positive -!> \retval bessk1 ... +!> \return ... ! ************************************************************************************************** FUNCTION bessk1(x) @@ -162,7 +162,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param x ... -!> \retval bessi0 ... +!> \return ... ! ************************************************************************************************** FUNCTION bessi0(x) @@ -194,7 +194,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param x ... -!> \retval bessi1 ... +!> \return ... ! ************************************************************************************************** FUNCTION bessi1(x) @@ -228,7 +228,7 @@ CONTAINS !> \brief ... !> \param x ... !> \param l ... -!> \retval bessel0 ... +!> \return ... ! ************************************************************************************************** FUNCTION bessel0(x, l) ! diff --git a/src/common/cp_array_utils.F b/src/common/cp_array_utils.F index 1458d63345..c8fceae7d4 100644 --- a/src/common/cp_array_utils.F +++ b/src/common/cp_array_utils.F @@ -257,7 +257,7 @@ END SUBROUTINE cp_2d_${nametype1}$_write !> \param el the element to look for !> \param l_index the lower index for binary search (defaults to 1) !> \param u_index the upper index for binary search (defaults to size(array)) -!> \retval res ... +!> \return ... !> \par History !> 06.2003 created [fawzi] !> \author Fawzi Mohamed diff --git a/src/common/cp_error_handling.F b/src/common/cp_error_handling.F index 5b781d1641..b8cbd821b2 100644 --- a/src/common/cp_error_handling.F +++ b/src/common/cp_error_handling.F @@ -209,7 +209,7 @@ CONTAINS !> \param message ... !> \param pos ... !> \param rowlen ... -!> \retval ibreak ... +!> \return ... !> \author Ole Schuett ! ************************************************************************************************** FUNCTION next_linebreak(message, pos, rowlen) RESULT(ibreak) diff --git a/src/common/cp_files.F b/src/common/cp_files.F index a16098b0df..e348c3f7b8 100644 --- a/src/common/cp_files.F +++ b/src/common/cp_files.F @@ -233,7 +233,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Returns the first logical unit that is not preconnected !> \param file_name ... -!> \retval unit_number ... +!> \return ... !> \author Matthias Krack (MK) !> \note !> -1 if no free unit exists @@ -490,7 +490,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Checks if file exists, considering also the file discovery mechanism. !> \param file_name ... -!> \retval exist ... +!> \return ... !> \author Ole Schuett ! ************************************************************************************************** FUNCTION file_exists(file_name) RESULT(exist) @@ -506,7 +506,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Checks various locations for a file name. !> \param file_name ... -!> \retval real_file_name ... +!> \return ... !> \author Ole Schuett ! ************************************************************************************************** FUNCTION discover_file(file_name) RESULT(real_file_name) @@ -544,7 +544,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Returns path of data directory if set, otherwise an empty string -!> \retval data_dir_path ... +!> \return ... !> \author Ole Schuett ! ************************************************************************************************** FUNCTION get_data_dir() RESULT(data_dir_path) @@ -567,7 +567,7 @@ CONTAINS !> \brief Joins two file-paths, inserting '/' as needed. !> \param path1 ... !> \param path2 ... -!> \retval joined_path ... +!> \return ... !> \author Ole Schuett ! ************************************************************************************************** FUNCTION join_paths(path1, path2) RESULT(joined_path) diff --git a/src/common/cp_linked_list.fypp b/src/common/cp_linked_list.fypp index d2b46b0afc..f63f7b5639 100644 --- a/src/common/cp_linked_list.fypp +++ b/src/common/cp_linked_list.fypp @@ -262,7 +262,7 @@ ${private_routines}$ ! ************************************************************************************************** !> \brief returns the first element stored in the list !> \param sll the single linked list to get the element from -!> \retval res ... +!> \return ... !> \par History !> none !> \author Fawzi Mohamed @@ -283,7 +283,7 @@ ${private_routines}$ !> \param sll the single linked list to get the rest from !> \param iter how many times the call to rest should be iterated, !> defaults to 1; -1 means till end of the list. -!> \retval res ... +!> \return ... !> \par History !> none !> \author Fawzi Mohamed @@ -328,7 +328,7 @@ ${private_routines}$ ! ************************************************************************************************** !> \brief returns the length of the list !> \param sll the list you want to know the length of -!> \retval res ... +!> \return ... !> \par History !> none !> \author Fawzi Mohamed @@ -360,7 +360,7 @@ ${private_routines}$ !> \brief returns the element at the given index !> \param sll the list you get the element from !> \param index the position of the element (stating at 1) -!> \retval res ... +!> \return ... !> \par History !> none !> \author Fawzi Mohamed @@ -426,7 +426,7 @@ ${private_routines}$ !> moves the iterator to the next element !> \param iterator iterator that moves along the list !> \param el_att the actual element (valid only if the function returns true) -!> \retval res ... +!> \return ... !> \par History !> none !> \author Fawzi Mohamed @@ -602,7 +602,7 @@ ${private_routines}$ !> \brief returns a newly allocated array with the same contents as !> the linked list !> \param sll the list to trasform in array -!> \retval res ... +!> \return ... !> \par History !> 07.2002 created [fawzi] !> \author Fawzi Mohamed diff --git a/src/common/cp_log_handling.F b/src/common/cp_log_handling.F index a85b5197cf..5ca67242fd 100644 --- a/src/common/cp_log_handling.F +++ b/src/common/cp_log_handling.F @@ -167,7 +167,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... -!> \retval res ... +!> \return ... !> \author fawzi ! ************************************************************************************************** FUNCTION cp_default_logger_stack_size() RESULT(res) @@ -227,7 +227,7 @@ CONTAINS ! ************************************************************************************************** !> \brief returns the default logger -!> \retval res ... +!> \return ... !> \par History !> 4.2002 created [fawzi] !> \author Fawzi Mohamed @@ -471,7 +471,7 @@ CONTAINS !> \param logger the logger you want to log in !> \param level describes the of the message: cp_fatal_level(3), !> cp_failure_level(2), cp_warning_level(1), cp_note_level(0). -!> \retval res ... +!> \return ... !> \par History !> 4.2002 revised [fawzi] !> \author Fawzi Mohamed @@ -501,7 +501,7 @@ CONTAINS !> returns a global logger (only the process with para_env%mepos== !> para_env%source should write to the global logger). Defaults to !> false -!> \retval res ... +!> \return ... !> \par History !> 4.2002 revised [fawzi] !> \author Fawzi Mohamed @@ -518,7 +518,7 @@ CONTAINS !> \brief returns the unit nr for the ionode (-1 on all other processors) !> skips as well checks if the procs calling this function is not the ionode !> \param logger the logger you want to log in -!> \retval res ... +!> \return ... !> \par History !> 12.2009 created [tlaino] !> \author Teodoro Laino @@ -569,7 +569,7 @@ CONTAINS !> \param logger the logger you want info from !> \param local if you want the local unit nr (defaults to false) !> \param skip_not_ionode ... -!> \retval res ... +!> \return ... !> \par History !> 4.2002 revised [fawzi] !> \author Fawzi Mohamed @@ -773,7 +773,7 @@ CONTAINS !> (should be a variable length string, but that does not work with !> all the compilers) !> \param i the integer to convert -!> \retval res ... +!> \return ... !> \par History !> 4.2002 revised [fawzi] !> \author Fawzi Mohamed @@ -805,7 +805,7 @@ CONTAINS !> (should be a variable length string, but that does not work with !> all the compilers) !> \param val the number to convert -!> \retval res ... +!> \return ... !> \par History !> 4.2002 revised [fawzi] !> \author Fawzi Mohamed @@ -820,7 +820,7 @@ CONTAINS ! ************************************************************************************************** !> \brief convert a logical in a string ('T' or 'F') !> \param val the number to convert -!> \retval res ... +!> \return ... !> \author fawzi ! ************************************************************************************************** FUNCTION cp_logical_to_string(val) RESULT(res) diff --git a/src/common/cp_min_heap.F b/src/common/cp_min_heap.F index c56173007e..c0e7afa781 100644 --- a/src/common/cp_min_heap.F +++ b/src/common/cp_min_heap.F @@ -42,7 +42,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param n ... -!> \retval parent ... +!> \return ... ! ************************************************************************************************** ELEMENTAL FUNCTION get_parent(n) RESULT(parent) INTEGER, INTENT(IN) :: n @@ -54,7 +54,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param n ... -!> \retval child ... +!> \return ... ! ************************************************************************************************** ELEMENTAL FUNCTION get_left_child(n) RESULT(child) INTEGER, INTENT(IN) :: n @@ -66,7 +66,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param n ... -!> \retval child ... +!> \return ... ! ************************************************************************************************** ELEMENTAL FUNCTION get_right_child(n) RESULT(child) INTEGER, INTENT(IN) :: n @@ -79,7 +79,7 @@ CONTAINS !> \brief ... !> \param heap ... !> \param n ... -!> \retval value ... +!> \return ... ! ************************************************************************************************** ELEMENTAL FUNCTION get_value(heap, n) RESULT(value) TYPE(cp_heap_type), INTENT(IN) :: heap @@ -93,7 +93,7 @@ CONTAINS !> \brief ... !> \param heap ... !> \param key ... -!> \retval value ... +!> \return ... ! ************************************************************************************************** ELEMENTAL FUNCTION get_value_by_key(heap, key) RESULT(value) TYPE(cp_heap_type), INTENT(IN) :: heap diff --git a/src/common/cp_result_methods.F b/src/common/cp_result_methods.F index 21239e5caf..dcb109eb27 100644 --- a/src/common/cp_result_methods.F +++ b/src/common/cp_result_methods.F @@ -121,7 +121,7 @@ CONTAINS !> \brief test for a certain result in the result_list !> \param results ... !> \param description ... -!> \retval res_exist ... +!> \return ... !> \par History !> 10.2013 !> \author Mandes diff --git a/src/common/cp_units.F b/src/common/cp_units.F index 9edebddbc2..8c0fca48ac 100644 --- a/src/common/cp_units.F +++ b/src/common/cp_units.F @@ -674,7 +674,7 @@ CONTAINS !> \param basic_kind the kind of the unit of the value !> \param basic_unit the unit of the value !> \param power the power of the unit (defaults to 1) -!> \retval res ... +!> \return ... !> \author fawzi ! ************************************************************************************************** FUNCTION cp_basic_unit_to_cp2k(value, basic_kind, basic_unit, power) RESULT(res) @@ -842,7 +842,7 @@ CONTAINS !> \param basic_unit the unit of the value !> \param power the power of the unit (defaults to 1) !> \param accept_undefined ... -!> \retval res ... +!> \return ... !> \author fawzi ! ************************************************************************************************** FUNCTION cp_basic_unit_desc(basic_kind, basic_unit, power, accept_undefined) & @@ -1071,7 +1071,7 @@ CONTAINS !> \param defaults defaults for the undefined units, optional !> \param accept_undefined if defaults is not present or is not associated !> whether undefined units should be accepted (defaults to false) -!> \retval res ... +!> \return ... !> \author fawzi ! ************************************************************************************************** FUNCTION cp_unit_desc(unit, defaults, accept_undefined) & @@ -1124,7 +1124,7 @@ CONTAINS !> \param defaults the defaults unit for those that are left free !> (cp_units_none) !> \param power the power of the unit (defaults to 1) -!> \retval res ... +!> \return ... !> \author fawzi ! ************************************************************************************************** FUNCTION cp_unit_to_cp2k1(value, unit, defaults, power) RESULT(res) @@ -1165,7 +1165,7 @@ CONTAINS !> \param defaults the defaults unit for those that are left free !> (cp_units_none) !> \param power the power of the unit (defaults to 1) -!> \retval res ... +!> \return ... !> \author fawzi ! ************************************************************************************************** FUNCTION cp_unit_from_cp2k1(value, unit, defaults, power) RESULT(res) @@ -1197,7 +1197,7 @@ CONTAINS !> \param defaults the defaults unit for those that are left free !> (cp_units_none) !> \param power the power of the unit (defaults to 1) -!> \retval res ... +!> \return ... !> \author fawzi ! ************************************************************************************************** FUNCTION cp_unit_to_cp2k(value, unit_str, defaults, power) RESULT(res) @@ -1230,7 +1230,7 @@ CONTAINS !> \param defaults the defaults unit for those that are left free !> (cp_units_none) !> \param power the power of the unit (defaults to 1) -!> \retval res ... +!> \return ... !> \author fawzi ! ************************************************************************************************** FUNCTION cp_unit_from_cp2k(value, unit_str, defaults, power) RESULT(res) @@ -1260,7 +1260,7 @@ CONTAINS !> \brief returs true if the two units are compatible !> \param ref_unit ... !> \param unit ... -!> \retval res ... +!> \return ... !> \author Teodoro Laino [tlaino] - 11.2007 - University of Zurich ! ************************************************************************************************** FUNCTION cp_unit_compatible(ref_unit, unit) RESULT(res) diff --git a/src/common/dict.F b/src/common/dict.F index 1f16de7033..b1bd242031 100644 --- a/src/common/dict.F +++ b/src/common/dict.F @@ -161,7 +161,7 @@ END SUBROUTINE dict_${keytype}$_${valuetype}$_init ! ************************************************************************************************** !> \brief Test if the given dictionary has been initialized. !> \param dict ... -!> \retval res ... +!> \return ... !> \par History !> 12.2012 created [ole] !> \author Ole Schuett @@ -325,7 +325,7 @@ END SUBROUTINE change_capacity_${keytype}$_${valuetype}$ !> \param dict ... !> \param key ... !> \param default_value ... -!> \retval value ... +!> \return ... !> \par History !> 12.2012 created [ole] !> \author Ole Schuett @@ -409,7 +409,7 @@ END SUBROUTINE dict_${keytype}$_${valuetype}$_del ! ************************************************************************************************** !> \brief Returns the number of key/value-items currently stored in the dictionary. !> \param dict ... -!> \retval size ... +!> \return ... !> \par History !> 12.2012 created [ole] !> \author Ole Schuett @@ -428,7 +428,7 @@ END FUNCTION dict_${keytype}$_${valuetype}$_size !> \brief Checks whether a given key is currently stored in the dictionary. !> \param dict ... !> \param key ... -!> \retval res ... +!> \return ... !> \par History !> 12.2012 created [ole] !> \author Ole Schuett @@ -467,7 +467,7 @@ END FUNCTION dict_${keytype}$_${valuetype}$_haskey !> \brief Returns a pointer to an array of all key/value-items stored in the dictionary. !> Caution: The caller is responsible for deallocating targeted array after usage. !> \param dict ... -!> \retval items ... +!> \return ... !> \par History !> 12.2012 created [ole] !> \author Ole Schuett diff --git a/src/common/dict.fypp b/src/common/dict.fypp index 22ee308263..96facc65f0 100644 --- a/src/common/dict.fypp +++ b/src/common/dict.fypp @@ -29,7 +29,7 @@ ALL(${k1}$==${k2}$) ! !> \brief generates the hash of a given string !> \param key a string of any length -!> \retval hash ... +!> \return ... !> \par History !> 09.2006 created [Joost VandeVondele] !> 12.2012 copied and adopted [ole] diff --git a/src/common/erf_fn.F b/src/common/erf_fn.F index 5dcc7dc386..e0a2f8675e 100644 --- a/src/common/erf_fn.F +++ b/src/common/erf_fn.F @@ -299,7 +299,7 @@ END SUBROUTINE CALERF ! ************************************************************************************************** !> \brief ... !> \param x ... -!> \retval erf_val ... +!> \return ... ! ************************************************************************************************** #if defined(__F2008) FUNCTION cp2k_erf(x) RESULT(erf_val) @@ -311,7 +311,7 @@ END SUBROUTINE CALERF ! ************************************************************************************************** !> \brief ... !> \param x ... -!> \retval erf_val ... +!> \return ... ! ************************************************************************************************** FUNCTION erf(x) RESULT(erf_val) REAL(KIND=dp) :: x, erf_val @@ -328,7 +328,7 @@ END SUBROUTINE CALERF ! ************************************************************************************************** !> \brief ... !> \param x ... -!> \retval erfc_val ... +!> \return ... ! ************************************************************************************************** #if defined(__F2008) FUNCTION cp2k_erfc(x) RESULT(erfc_val) @@ -340,7 +340,7 @@ END SUBROUTINE CALERF ! ************************************************************************************************** !> \brief ... !> \param x ... -!> \retval erfc_val ... +!> \return ... ! ************************************************************************************************** FUNCTION erfc(x) RESULT(erfc_val) REAL(KIND=dp) :: x, erfc_val @@ -357,7 +357,7 @@ END SUBROUTINE CALERF ! ************************************************************************************************** !> \brief ... !> \param x ... -!> \retval erfcx_val ... +!> \return ... ! ************************************************************************************************** FUNCTION erfcx(x) RESULT(erfcx_val) REAL(KIND=dp) :: x, erfcx_val diff --git a/src/common/fparser.F b/src/common/fparser.F index 59a99e0637..5d50daa784 100644 --- a/src/common/fparser.F +++ b/src/common/fparser.F @@ -181,7 +181,7 @@ CONTAINS !> \brief ... !> \param i ... !> \param Val ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** FUNCTION evalf(i, Val) RESULT(res) !----- -------- --------- --------- --------- --------- --------- --------- ------- @@ -351,7 +351,7 @@ CONTAINS ! ! ************************************************************************************************** !> \brief ... -!> \retval msg ... +!> \return ... ! ************************************************************************************************** FUNCTION EvalErrMsg() RESULT(msg) !----- -------- --------- --------- --------- --------- --------- --------- ------- @@ -410,7 +410,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param c ... -!> \retval n ... +!> \return ... ! ************************************************************************************************** FUNCTION OperatorIndex(c) RESULT(n) !----- -------- --------- --------- --------- --------- --------- --------- ------- @@ -435,7 +435,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param str ... -!> \retval n ... +!> \return ... ! ************************************************************************************************** FUNCTION MathFunctionIndex(str) RESULT(n) !----- -------- --------- --------- --------- --------- --------- --------- ------- @@ -467,7 +467,7 @@ CONTAINS !> \param Var ... !> \param ibegin ... !> \param inext ... -!> \retval n ... +!> \return ... ! ************************************************************************************************** FUNCTION VariableIndex(str, Var, ibegin, inext) RESULT(n) !----- -------- --------- --------- --------- --------- --------- --------- ------- @@ -624,7 +624,7 @@ CONTAINS !> \param i ... !> \param F ... !> \param Var ... -!> \retval n ... +!> \return ... ! ************************************************************************************************** FUNCTION MathItemIndex(i, F, Var) RESULT(n) !----- -------- --------- --------- --------- --------- --------- --------- ------- @@ -657,7 +657,7 @@ CONTAINS !> \param F ... !> \param b ... !> \param e ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** FUNCTION CompletelyEnclosed(F, b, e) RESULT(res) !----- -------- --------- --------- --------- --------- --------- --------- ------- @@ -803,7 +803,7 @@ CONTAINS !> \brief ... !> \param j ... !> \param F ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** FUNCTION IsBinaryOp(j, F) RESULT(res) !----- -------- --------- --------- --------- --------- --------- --------- ------- @@ -858,7 +858,7 @@ CONTAINS !> \param ibegin ... !> \param inext ... !> \param error ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** FUNCTION RealNum(str, ibegin, inext, error) RESULT(res) !----- -------- --------- --------- --------- --------- --------- --------- ------- @@ -978,7 +978,7 @@ CONTAINS !> \param vals ... !> \param h ... !> \param err ... -!> \retval derivative ... +!> \return ... !> \author Main algorithm from Numerical Recipes !> Ridders, C.J.F. 1982 - Advances in Engineering Software, Vol.4, no. 2, pp. 75-76 ! ************************************************************************************************** diff --git a/src/common/gamma.F b/src/common/gamma.F index bc8f6ea0a0..6dc60488b5 100644 --- a/src/common/gamma.F +++ b/src/common/gamma.F @@ -407,7 +407,7 @@ CONTAINS !> of F_n(t) values or for reference calculations. !> \param nmax ... !> \param t ... -!> \retval f ... +!> \return ... !> \date 07.01.1999 !> \par Literature !> F. E. Harris, Int. J. Quant. Chem. 23, 1469 (1983) diff --git a/src/common/glob_matching.F b/src/common/glob_matching.F index c623391509..043c438908 100644 --- a/src/common/glob_matching.F +++ b/src/common/glob_matching.F @@ -38,7 +38,7 @@ CONTAINS !> \brief ... !> \param string ... !> \param pattern ... -!> \retval match ... +!> \return ... ! ************************************************************************************************** RECURSIVE FUNCTION string_match(string, pattern) RESULT(match) CHARACTER(len=*), INTENT(in) :: string, pattern diff --git a/src/common/kahan_sum.F b/src/common/kahan_sum.F index b18a016ce1..e3b354ec32 100644 --- a/src/common/kahan_sum.F +++ b/src/common/kahan_sum.F @@ -57,7 +57,7 @@ CONTAINS !> \brief ... !> \param array ... !> \param mask ... -!> \retval ks ... +!> \return ... ! ************************************************************************************************** FUNCTION kahan_sum_s1(array, mask) RESULT(ks) REAL(KIND=sp), DIMENSION(:), INTENT(IN) :: array @@ -92,7 +92,7 @@ CONTAINS !> \brief ... !> \param array ... !> \param mask ... -!> \retval ks ... +!> \return ... ! ************************************************************************************************** FUNCTION kahan_sum_d1(array, mask) RESULT(ks) REAL(KIND=dp), DIMENSION(:), INTENT(IN) :: array @@ -127,7 +127,7 @@ CONTAINS !> \brief computes the accurate sum of an array that is the element wise product of two input arrays. !> \param array1 array of real numbers !> \param array2 another array of real numbers -!> \retval ks dot product +!> \return dot product ! ************************************************************************************************** FUNCTION kahan_dot_product_d1(array1, array2) RESULT(ks) REAL(KIND=dp), DIMENSION(:), INTENT(in) :: array1, array2 @@ -151,7 +151,7 @@ CONTAINS !> \brief ... !> \param array ... !> \param mask ... -!> \retval ks ... +!> \return ... ! ************************************************************************************************** FUNCTION kahan_sum_c1(array, mask) RESULT(ks) COMPLEX(KIND=sp), DIMENSION(:), INTENT(IN) :: array @@ -186,7 +186,7 @@ CONTAINS !> \brief ... !> \param array ... !> \param mask ... -!> \retval ks ... +!> \return ... ! ************************************************************************************************** FUNCTION kahan_sum_z1(array, mask) RESULT(ks) COMPLEX(KIND=dp), DIMENSION(:), INTENT(IN) :: array @@ -221,7 +221,7 @@ CONTAINS !> \brief ... !> \param array ... !> \param mask ... -!> \retval ks ... +!> \return ... ! ************************************************************************************************** FUNCTION kahan_sum_s2(array, mask) RESULT(ks) REAL(KIND=sp), DIMENSION(:, :), INTENT(IN) :: array @@ -260,7 +260,7 @@ CONTAINS !> \brief computes the accurate sum of an array that is the element wise product of two input arrays. !> \param array1 2-D array of real numbers !> \param array2 another 2-D array of real numbers -!> \retval ks dot product +!> \return dot product ! ************************************************************************************************** FUNCTION kahan_dot_product_s2(array1, array2) RESULT(ks) REAL(KIND=sp), DIMENSION(:, :), INTENT(in) :: array1, array2 @@ -287,7 +287,7 @@ CONTAINS !> \brief ... !> \param array ... !> \param mask ... -!> \retval ks ... +!> \return ... ! ************************************************************************************************** FUNCTION kahan_sum_d2(array, mask) RESULT(ks) REAL(KIND=dp), DIMENSION(:, :), INTENT(IN) :: array @@ -326,7 +326,7 @@ CONTAINS !> \brief computes the accurate sum of an array that is the element wise product of two input arrays. !> \param array1 2-D array of real numbers !> \param array2 another 2-D array of real numbers -!> \retval ks dot product +!> \return dot product ! ************************************************************************************************** FUNCTION kahan_dot_product_d2(array1, array2) RESULT(ks) REAL(KIND=dp), DIMENSION(:, :), INTENT(in) :: array1, array2 @@ -353,7 +353,7 @@ CONTAINS !> \brief ... !> \param array ... !> \param mask ... -!> \retval ks ... +!> \return ... ! ************************************************************************************************** FUNCTION kahan_sum_c2(array, mask) RESULT(ks) COMPLEX(KIND=sp), DIMENSION(:, :), INTENT(IN) :: array @@ -392,7 +392,7 @@ CONTAINS !> \brief ... !> \param array ... !> \param mask ... -!> \retval ks ... +!> \return ... ! ************************************************************************************************** FUNCTION kahan_sum_z2(array, mask) RESULT(ks) COMPLEX(KIND=dp), DIMENSION(:, :), INTENT(IN) :: array @@ -431,7 +431,7 @@ CONTAINS !> \brief computes the accurate sum of an array that is the element wise product of two input arrays. !> \param array1 2-D array of complex numbers !> \param array2 another 2-D array of complex numbers -!> \retval ks dot product +!> \return dot product ! ************************************************************************************************** FUNCTION kahan_dot_product_z2(array1, array2) RESULT(ks) COMPLEX(KIND=dp), DIMENSION(:, :), INTENT(in) :: array1, array2 @@ -458,7 +458,7 @@ CONTAINS !> \brief ... !> \param array ... !> \param mask ... -!> \retval ks ... +!> \return ... ! ************************************************************************************************** FUNCTION kahan_sum_s3(array, mask) RESULT(ks) REAL(KIND=sp), DIMENSION(:, :, :), INTENT(IN) :: array @@ -501,7 +501,7 @@ CONTAINS !> \brief ... !> \param array ... !> \param mask ... -!> \retval ks ... +!> \return ... ! ************************************************************************************************** FUNCTION kahan_sum_d3(array, mask) RESULT(ks) REAL(KIND=dp), DIMENSION(:, :, :), INTENT(IN) :: array @@ -548,7 +548,7 @@ CONTAINS !> \param mask the mask array !> \param th screening threshold: only array points where the value of mask is greater than th are !> included in the sum -!> \retval ks the result of summation +!> \return the result of summation ! ************************************************************************************************** FUNCTION kahan_dot_product_masked_d3(array1, array2, mask, th) RESULT(ks) REAL(KIND=dp), DIMENSION(:, :, :), INTENT(IN), & @@ -579,7 +579,7 @@ CONTAINS !> \brief ... !> \param array ... !> \param mask ... -!> \retval ks ... +!> \return ... ! ************************************************************************************************** FUNCTION kahan_sum_c3(array, mask) RESULT(ks) COMPLEX(KIND=sp), DIMENSION(:, :, :), INTENT(IN) :: array @@ -622,7 +622,7 @@ CONTAINS !> \brief ... !> \param array ... !> \param mask ... -!> \retval ks ... +!> \return ... ! ************************************************************************************************** FUNCTION kahan_sum_z3(array, mask) RESULT(ks) COMPLEX(KIND=dp), DIMENSION(:, :, :), INTENT(IN) :: array @@ -665,7 +665,7 @@ CONTAINS !> \brief ... !> \param array ... !> \param mask ... -!> \retval ks ... +!> \return ... ! ************************************************************************************************** FUNCTION kahan_sum_s4(array, mask) RESULT(ks) REAL(KIND=sp), DIMENSION(:, :, :, :), INTENT(IN) :: array @@ -713,7 +713,7 @@ CONTAINS !> \brief ... !> \param array ... !> \param mask ... -!> \retval ks ... +!> \return ... ! ************************************************************************************************** FUNCTION kahan_sum_d4(array, mask) RESULT(ks) REAL(KIND=dp), DIMENSION(:, :, :, :), INTENT(IN) :: array @@ -761,7 +761,7 @@ CONTAINS !> \brief ... !> \param array ... !> \param mask ... -!> \retval ks ... +!> \return ... ! ************************************************************************************************** FUNCTION kahan_sum_c4(array, mask) RESULT(ks) COMPLEX(KIND=sp), DIMENSION(:, :, :, :), & @@ -810,7 +810,7 @@ CONTAINS !> \brief ... !> \param array ... !> \param mask ... -!> \retval ks ... +!> \return ... ! ************************************************************************************************** FUNCTION kahan_sum_z4(array, mask) RESULT(ks) COMPLEX(KIND=dp), DIMENSION(:, :, :, :), & @@ -859,7 +859,7 @@ CONTAINS !> \brief ... !> \param array ... !> \param mask ... -!> \retval ks ... +!> \return ... ! ************************************************************************************************** FUNCTION kahan_sum_s5(array, mask) RESULT(ks) REAL(KIND=sp), DIMENSION(:, :, :, :, :), & @@ -912,7 +912,7 @@ CONTAINS !> \brief ... !> \param array ... !> \param mask ... -!> \retval ks ... +!> \return ... ! ************************************************************************************************** FUNCTION kahan_sum_d5(array, mask) RESULT(ks) REAL(KIND=dp), DIMENSION(:, :, :, :, :), & @@ -965,7 +965,7 @@ CONTAINS !> \brief ... !> \param array ... !> \param mask ... -!> \retval ks ... +!> \return ... ! ************************************************************************************************** FUNCTION kahan_sum_c5(array, mask) RESULT(ks) COMPLEX(KIND=sp), DIMENSION(:, :, :, :, :), & @@ -1018,7 +1018,7 @@ CONTAINS !> \brief ... !> \param array ... !> \param mask ... -!> \retval ks ... +!> \return ... ! ************************************************************************************************** FUNCTION kahan_sum_z5(array, mask) RESULT(ks) COMPLEX(KIND=dp), DIMENSION(:, :, :, :, :), & @@ -1071,7 +1071,7 @@ CONTAINS !> \brief ... !> \param array ... !> \param mask ... -!> \retval ks ... +!> \return ... ! ************************************************************************************************** FUNCTION kahan_sum_s6(array, mask) RESULT(ks) REAL(KIND=sp), DIMENSION(:, :, :, :, :, :), & @@ -1128,7 +1128,7 @@ CONTAINS !> \brief ... !> \param array ... !> \param mask ... -!> \retval ks ... +!> \return ... ! ************************************************************************************************** FUNCTION kahan_sum_d6(array, mask) RESULT(ks) REAL(KIND=dp), DIMENSION(:, :, :, :, :, :), & @@ -1185,7 +1185,7 @@ CONTAINS !> \brief ... !> \param array ... !> \param mask ... -!> \retval ks ... +!> \return ... ! ************************************************************************************************** FUNCTION kahan_sum_c6(array, mask) RESULT(ks) COMPLEX(KIND=sp), DIMENSION(:, :, :, :, :, :), & @@ -1242,7 +1242,7 @@ CONTAINS !> \brief ... !> \param array ... !> \param mask ... -!> \retval ks ... +!> \return ... ! ************************************************************************************************** FUNCTION kahan_sum_z6(array, mask) RESULT(ks) COMPLEX(KIND=dp), DIMENSION(:, :, :, :, :, :), & @@ -1299,7 +1299,7 @@ CONTAINS !> \brief ... !> \param array ... !> \param mask ... -!> \retval ks ... +!> \return ... ! ************************************************************************************************** FUNCTION kahan_sum_s7(array, mask) RESULT(ks) REAL(KIND=sp), DIMENSION(:, :, :, :, :, :, :), & @@ -1360,7 +1360,7 @@ CONTAINS !> \brief ... !> \param array ... !> \param mask ... -!> \retval ks ... +!> \return ... ! ************************************************************************************************** FUNCTION kahan_sum_d7(array, mask) RESULT(ks) REAL(KIND=dp), DIMENSION(:, :, :, :, :, :, :), & @@ -1421,7 +1421,7 @@ CONTAINS !> \brief ... !> \param array ... !> \param mask ... -!> \retval ks ... +!> \return ... ! ************************************************************************************************** FUNCTION kahan_sum_c7(array, mask) RESULT(ks) COMPLEX(KIND=sp), DIMENSION(:, :, :, :, :, :, :), & @@ -1482,7 +1482,7 @@ CONTAINS !> \brief ... !> \param array ... !> \param mask ... -!> \retval ks ... +!> \return ... ! ************************************************************************************************** FUNCTION kahan_sum_z7(array, mask) RESULT(ks) COMPLEX(KIND=dp), DIMENSION(:, :, :, :, :, :, :), & diff --git a/src/common/lebedev.F b/src/common/lebedev.F index 0f4b5ecd21..43f6a3cc15 100644 --- a/src/common/lebedev.F +++ b/src/common/lebedev.F @@ -100,7 +100,7 @@ CONTAINS !> angular momentum quantnum number l or size n. !> \param l ... !> \param n ... -!> \retval number_of_lebedev_grid ... +!> \return ... !> \date 05.05.99 !> \par Variables !> \author Matthias Krack diff --git a/src/common/list.fypp b/src/common/list.fypp index 8f2f68aa99..5105ee1bc7 100644 --- a/src/common/list.fypp +++ b/src/common/list.fypp @@ -55,7 +55,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Test if the given list has been initialized. !> \param list ... -!> \retval res ... +!> \return ... !> \par History !> 12.2012 created [ole] !> \author Ole Schuett @@ -214,7 +214,7 @@ END SUBROUTINE list_${valuetype}$_insert !> \brief Returns the last element in the list. !> Is equivalent to: list_${valuetype}$_get(list, list_${valuetype}$_size(list)) !> \param list ... -!> \retval value ... +!> \return ... !> \par History !> 12.2012 created [ole] !> \author Ole Schuett @@ -239,7 +239,7 @@ END FUNCTION list_${valuetype}$_peek !> call list_${valuetype}$_del(list, list_${valuetype}$_size(list)) !> !> \param list ... -!> \retval value ... +!> \return ... !> \par History !> 12.2012 created [ole] !> \author Ole Schuett @@ -286,7 +286,7 @@ END SUBROUTINE list_${valuetype}$_clear !> \brief Returns the value at the given position from the list. !> \param list ... !> \param pos Position in the list - musst fulfill 0 < pos < list_size+1 . -!> \retval value ... +!> \return ... !> \par History !> 12.2012 created [ole] !> \author Ole Schuett @@ -340,7 +340,7 @@ END SUBROUTINE list_${valuetype}$_del ! ************************************************************************************************** !> \brief Returns the current size of the list. !> \param list ... -!> \retval size ... +!> \return ... !> \par History !> 12.2012 created [ole] !> \author Ole Schuett diff --git a/src/common/mathlib.F b/src/common/mathlib.F index 911655cefa..2ea75a0bf6 100644 --- a/src/common/mathlib.F +++ b/src/common/mathlib.F @@ -87,9 +87,9 @@ CONTAINS !> \param a ... !> \param b ... !> \param order ... -!> \retval order =0 : f(x) -!> \retval order =1 : f'(x) -!> \retval order =2 : f"(x) +!> \return =0 : f(x) +!> \return =1 : f'(x) +!> \return =2 : f"(x) ! ************************************************************************************************** FUNCTION pswitch(x, a, b, order) RESULT(fx) REAL(KIND=dp) :: x, a, b @@ -140,7 +140,7 @@ CONTAINS !> \brief determins if a value is not normal (e.g. for Inf and Nan) !> based on IO to work also under optimization. !> \param a input value -!> \retval abnormal_value TRUE for NaN and Inf +!> \return TRUE for NaN and Inf ! ************************************************************************************************** LOGICAL FUNCTION abnormal_value(a) REAL(KIND=dp) :: a @@ -161,7 +161,7 @@ CONTAINS !> The angle is returned in radians. !> \param a ... !> \param b ... -!> \retval angle_ab ... +!> \return ... !> \date 14.10.1998 !> \author MK !> \version 1.0 @@ -192,7 +192,7 @@ CONTAINS !> otherwise zero is returned. !> \param n ... !> \param k ... -!> \retval n_over_k ... +!> \return ... !> \date 08.03.1999 !> \author MK !> \version 1.0 @@ -214,7 +214,7 @@ CONTAINS !> \brief Calculates the multinomial coefficients !> \param n ... !> \param k ... -!> \retval res ... +!> \return ... !> \author Ole Schuett ! ************************************************************************************************** FUNCTION multinomial(n, k) RESULT(res) @@ -285,7 +285,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Returns the determinante of the 3x3 matrix a. !> \param a ... -!> \retval det_a ... +!> \return ... !> \date 13.03.2004 !> \author MK !> \version 1.0 @@ -305,7 +305,7 @@ CONTAINS !> \param a1 ... !> \param a2 ... !> \param a3 ... -!> \retval det_a ... +!> \return ... !> \date 13.03.2004 !> \author MK !> \version 1.0 @@ -426,7 +426,7 @@ CONTAINS !> \param ab ... !> \param bc ... !> \param cd ... -!> \retval dihedral_angle_abcd ... +!> \return ... !> \date 13.03.2004 !> \author MK !> \version 1.0 @@ -451,7 +451,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Return the diagonal elements of matrix a as a vector. !> \param a ... -!> \retval a_diag ... +!> \return ... !> \date 20.11.1998 !> \author MK !> \version 1.0 @@ -474,7 +474,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Returns the inverse of the 3 x 3 matrix a. !> \param a ... -!> \retval a_inv ... +!> \return ... !> \date 13.03.2004 !> \author MK !> \version 1.0 @@ -1068,7 +1068,7 @@ CONTAINS !> normal vector b. The reflected vector a is stored in a_mirror. !> \param a ... !> \param b ... -!> \retval a_mirror ... +!> \return ... !> \date 16.10.1998 !> \author MK !> \version 1.0 @@ -1107,7 +1107,7 @@ CONTAINS !> \param a ... !> \param phi ... !> \param b ... -!> \retval a_rot ... +!> \return ... !> \date 16.10.1998 !> \author MK !> \version 1.0 @@ -1249,7 +1249,7 @@ CONTAINS !> \brief Calculation of the vector product c = a x b. !> \param a ... !> \param b ... -!> \retval c ... +!> \return ... !> \date 16.10.1998 !> \author MK !> \version 1.0 @@ -1268,7 +1268,7 @@ CONTAINS !> \brief computes the greatest common divisor of two number !> \param a ... !> \param b ... -!> \retval gcd ... +!> \return ... !> \author Joost VandeVondele ! ************************************************************************************************** ELEMENTAL FUNCTION gcd(a, b) @@ -1303,7 +1303,7 @@ CONTAINS !> \brief computes the least common multiplier of two numbers !> \param a ... !> \param b ... -!> \retval lcm ... +!> \return ... !> \author Joost VandeVondele ! ************************************************************************************************** ELEMENTAL FUNCTION lcm(a, b) @@ -1325,7 +1325,7 @@ CONTAINS !> \brief computes the exponential integral !> Ei(x) = Int(exp(-x*t)/t,t=1..infinity) x>0 !> \param x ... -!> \retval ei ... +!> \return ... !> \author JGH (adapted from Numerical recipies) ! ************************************************************************************************** FUNCTION ei(x) @@ -1378,7 +1378,7 @@ CONTAINS !> \brief ... !> \param mat1 ... !> \param mat2 ... -!> \retval matmul_3x3 ... +!> \return ... ! ************************************************************************************************** FUNCTION matmul_3x3(mat1, mat2) REAL(KIND=dp), DIMENSION(3, 3), INTENT(IN) :: mat1, mat2 @@ -1415,7 +1415,7 @@ CONTAINS !> \brief ... !> \param vec1 ... !> \param vec2 ... -!> \retval dotprod_3d ... +!> \return ... ! ************************************************************************************************** FUNCTION dotprod_3d(vec1, vec2) REAL(KIND=dp), DIMENSION(3), INTENT(IN) :: vec1, vec2 @@ -1430,7 +1430,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param mat ... -!> \retval transpose_3d ... +!> \return ... ! ************************************************************************************************** FUNCTION transpose_3d(mat) REAL(KIND=dp), DIMENSION(3, 3), INTENT(IN) :: mat @@ -1451,7 +1451,7 @@ CONTAINS !> Note: Ei(-x) = -E1(x) !> \param n ... !> \param x ... -!> \retval expint ... +!> \return ... !> \par History !> 05.2007 Created !> \author Manuel Guidon (adapted from Numerical recipies) diff --git a/src/common/parallel_rng_types.F b/src/common/parallel_rng_types.F index 14c994771e..99e5dd5437 100644 --- a/src/common/parallel_rng_types.F +++ b/src/common/parallel_rng_types.F @@ -959,7 +959,7 @@ CONTAINS !> \param rng_stream ... !> \param low ... !> \param high ... -!> \retval u ... +!> \return ... ! ************************************************************************************************** FUNCTION next_integer_random_number(rng_stream, low, high) RESULT(u) @@ -989,7 +989,7 @@ CONTAINS !> \brief ... !> \param rng_stream ... !> \param variance ... -!> \retval u ... +!> \return ... ! ************************************************************************************************** FUNCTION next_real_random_number(rng_stream, variance) RESULT(u) @@ -1049,7 +1049,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param seed ... -!> \retval next_seed ... +!> \return ... ! ************************************************************************************************** FUNCTION next_rng_seed(seed) RESULT(next_seed) @@ -1264,7 +1264,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param rng_stream ... -!> \retval u ... +!> \return ... ! ************************************************************************************************** FUNCTION rn32(rng_stream) RESULT(u) @@ -1312,7 +1312,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param rng_stream ... -!> \retval u ... +!> \return ... ! ************************************************************************************************** FUNCTION rn53(rng_stream) RESULT(u) diff --git a/src/common/reference_manager.F b/src/common/reference_manager.F index 29cccbc72e..d2c0105383 100644 --- a/src/common/reference_manager.F +++ b/src/common/reference_manager.F @@ -486,7 +486,7 @@ CONTAINS !> on return it is updated, so that succesive calls give succesive fields !> \param ISI_record ... !> \param iline_start ... -!> \retval res ... +!> \return ... !> \par History !> 08.2007 created [Joost VandeVondele] ! ************************************************************************************************** @@ -522,7 +522,7 @@ CONTAINS !> \brief ... !> \param ISI_record ... !> \param iline_start ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** FUNCTION get_next_title(ISI_record,iline_start) RESULT(res) CHARACTER(LEN=ISI_length), DIMENSION(:), POINTER :: ISI_record @@ -554,7 +554,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param ISI_record ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** FUNCTION get_source(ISI_record) RESULT(res) CHARACTER(LEN=ISI_length), DIMENSION(:), POINTER :: ISI_record @@ -582,7 +582,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param ISI_record ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** FUNCTION get_year(ISI_record) RESULT(res) CHARACTER(LEN=ISI_length), DIMENSION(:), POINTER :: ISI_record @@ -600,7 +600,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param ISI_record ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** FUNCTION get_month(ISI_record) RESULT(res) CHARACTER(LEN=ISI_length), DIMENSION(:), POINTER :: ISI_record @@ -618,7 +618,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param ISI_record ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** FUNCTION get_day(ISI_record) RESULT(res) CHARACTER(LEN=ISI_length), DIMENSION(:), POINTER :: ISI_record @@ -644,7 +644,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param ISI_record ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** FUNCTION get_volume(ISI_record) RESULT(res) CHARACTER(LEN=ISI_length), DIMENSION(:), POINTER :: ISI_record @@ -662,7 +662,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param ISI_record ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** FUNCTION get_issue(ISI_record) RESULT(res) CHARACTER(LEN=ISI_length), DIMENSION(:), POINTER :: ISI_record @@ -680,7 +680,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param ISI_record ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** FUNCTION get_pages(ISI_record) RESULT(res) CHARACTER(LEN=ISI_length), DIMENSION(:), POINTER :: ISI_record @@ -710,7 +710,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param key ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** FUNCTION get_citation_key(key) RESULT(res) INTEGER :: key @@ -726,7 +726,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param ISI_record ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** FUNCTION get_epoch(ISI_record) RESULT(res) CHARACTER(LEN=ISI_length), DIMENSION(:), POINTER :: ISI_record diff --git a/src/common/spherical_harmonics.F b/src/common/spherical_harmonics.F index 70f03bf314..ebba03a9ca 100644 --- a/src/common/spherical_harmonics.F +++ b/src/common/spherical_harmonics.F @@ -146,7 +146,7 @@ CONTAINS !> \brief ... !> \param m1 ... !> \param m2 ... -!> \retval m ... +!> \return ... ! ************************************************************************************************** FUNCTION getm(m1, m2) RESULT(m) INTEGER, INTENT(IN) :: m1, m2 @@ -172,7 +172,7 @@ CONTAINS !> \param m1 ... !> \param m2 ... !> \param m ... -!> \retval f ... +!> \return ... ! ************************************************************************************************** FUNCTION get_factor(m1, m2, m) RESULT(f) INTEGER, INTENT(IN) :: m1, m2, m @@ -297,7 +297,7 @@ CONTAINS !> \param m2 ... !> \param lp ... !> \param mp ... -!> \retval cgc ... +!> \return ... ! ************************************************************************************************** FUNCTION cgc(l1, m1, l2, m2, lp, mp) INTEGER, INTENT(IN) :: l1, m1, l2, m2, lp, mp @@ -359,7 +359,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param n ... -!> \retval fval ... +!> \return ... ! ************************************************************************************************** FUNCTION sfac(n) RESULT(fval) INTEGER :: n @@ -385,7 +385,7 @@ CONTAINS !> \param m1 ... !> \param l2 ... !> \param m2 ... -!> \retval ind ... +!> \return ... ! ************************************************************************************************** FUNCTION order(l1, m1, l2, m2) RESULT(ind) INTEGER, INTENT(IN) :: l1, m1, l2, m2 @@ -1200,7 +1200,7 @@ CONTAINS !> \param x ... !> \param l ... !> \param m ... -!> \retval plm ... +!> \return ... ! ************************************************************************************************** FUNCTION legendre(x, l, m) RESULT(plm) @@ -1346,7 +1346,7 @@ CONTAINS !> \param x ... !> \param l ... !> \param m ... -!> \retval dplm ... +!> \return ... ! ************************************************************************************************** FUNCTION dlegendre(x, l, m) RESULT(dplm) REAL(KIND=dp), INTENT(IN) :: x @@ -1479,7 +1479,7 @@ CONTAINS !> \brief ... !> \param x ... !> \param l ... -!> \retval dPof1 ... +!> \return ... ! ************************************************************************************************** FUNCTION dPof1(x, l) @@ -1542,7 +1542,7 @@ CONTAINS !> \brief ... !> \param n ... !> \param k ... -!> \retval choose ... +!> \return ... ! ************************************************************************************************** FUNCTION choose(n, k) @@ -1562,7 +1562,7 @@ CONTAINS !> \param n ... !> \param c ... !> \param s ... -!> \retval cosn ... +!> \return ... ! ************************************************************************************************** FUNCTION cosn(n, c, s) @@ -1610,7 +1610,7 @@ CONTAINS !> \param n ... !> \param c ... !> \param s ... -!> \retval dcosn_dcp ... +!> \return ... ! ************************************************************************************************** FUNCTION dcosn_dcp(n, c, s) @@ -1646,7 +1646,7 @@ CONTAINS !> \param n ... !> \param c ... !> \param s ... -!> \retval dcosn_dsp ... +!> \return ... ! ************************************************************************************************** FUNCTION dcosn_dsp(n, c, s) @@ -1681,7 +1681,7 @@ CONTAINS !> \param n ... !> \param c ... !> \param s ... -!> \retval sinn ... +!> \return ... ! ************************************************************************************************** FUNCTION sinn(n, c, s) @@ -1728,7 +1728,7 @@ CONTAINS !> \param n ... !> \param c ... !> \param s ... -!> \retval dsinn_dcp ... +!> \return ... ! ************************************************************************************************** FUNCTION dsinn_dcp(n, c, s) @@ -1764,7 +1764,7 @@ CONTAINS !> \param n ... !> \param c ... !> \param s ... -!> \retval dsinn_dsp ... +!> \return ... ! ************************************************************************************************** FUNCTION dsinn_dsp(n, c, s) diff --git a/src/common/splines.F b/src/common/splines.F index 74acc404fd..25d5223cf9 100644 --- a/src/common/splines.F +++ b/src/common/splines.F @@ -44,7 +44,7 @@ CONTAINS !> \param x ... !> \param y ... !> \param xnew ... -!> \retval ynew ... +!> \return ... ! ************************************************************************************************** FUNCTION spline3(x, y, xnew) RESULT(ynew) ! Takes the function values 'y' on the grid 'x' and returns new values 'ynew' @@ -290,7 +290,7 @@ CONTAINS !> \brief ... !> \param x ... !> \param xi ... -!> \retval i1 ... +!> \return ... ! ************************************************************************************************** INTEGER FUNCTION iix(x, xi) RESULT(i1) ! Returns index i of interval [xi(i),xi(i+1)] containing x in mesh xi, @@ -343,7 +343,7 @@ CONTAINS !> \param x ... !> \param xi ... !> \param i_min ... -!> \retval ip ... +!> \return ... ! ************************************************************************************************** INTEGER FUNCTION iixmin(x, xi, i_min) RESULT(ip) ! Just like iix, but assumes that x >= xi(i_min) @@ -364,7 +364,7 @@ CONTAINS !> \param n ... !> \param x1 ... !> \param xn ... -!> \retval iixun ... +!> \return ... ! ************************************************************************************************** FUNCTION iixun(x, n, x1, xn) ! Returns index i of interval [x(i),x(i+1)] containing x in uniform mesh defined by @@ -401,7 +401,7 @@ CONTAINS !> \param x1 ... !> \param alpha ... !> \param beta ... -!> \retval iixexp ... +!> \return ... ! ************************************************************************************************** FUNCTION iixexp(x, n, x1, alpha, beta) ! Returns index i of interval [x(i),x(i+1)] containing x in exponential mesh defined by @@ -441,7 +441,7 @@ CONTAINS !> \brief ... !> \param x ... !> \param c ... -!> \retval poly3 ... +!> \return ... ! ************************************************************************************************** FUNCTION poly3(x, c) ! returns value of polynomial \sum_{i=1}^4 c(i) (x-c(0))^(i-1) @@ -463,7 +463,7 @@ CONTAINS !> \brief ... !> \param x ... !> \param c ... -!> \retval dpoly3 ... +!> \return ... ! ************************************************************************************************** FUNCTION dpoly3(x, c) ! returns 1st derivative of polynomial \sum_{i=1}^4 c(i) (x-c(0))^(i-1) @@ -485,7 +485,7 @@ CONTAINS !> \brief ... !> \param x ... !> \param c ... -!> \retval d2poly3 ... +!> \return ... ! ************************************************************************************************** FUNCTION d2poly3(x, c) ! returns 2nd derivative of polynomial \sum_{i=1}^4 c(i) (x-c(0))^(i-1) diff --git a/src/common/string_table.F b/src/common/string_table.F index c3bc89c97d..e74722f56f 100644 --- a/src/common/string_table.F +++ b/src/common/string_table.F @@ -58,7 +58,7 @@ CONTAINS !> \brief returns a unique id for a given string, and stores the string for !> later retrieval using the id. !> \param str the string to be stored (default_string_length) -!> \retval id ... +!> \return ... !> \par History !> 09.2006 created [Joost VandeVondele] !> \note @@ -102,7 +102,7 @@ CONTAINS ! ************************************************************************************************** !> \brief returns the string associated with a given id !> \param id the id to be converted into a string -!> \retval str ... +!> \return ... !> \par History !> 09.2006 created [Joost VandeVondele] !> \note @@ -128,7 +128,7 @@ CONTAINS ! ************************************************************************************************** !> \brief converts a string in a string of default_string_length !> \param str ... -!> \retval res ... +!> \return ... !> \par History !> 09.2006 created [Joost VandeVondele] !> \note @@ -204,7 +204,7 @@ CONTAINS ! ************************************************************************************************** !> \brief generates the hash of a string and the index in the table !> \param key a string of any length -!> \retval hash_index ... +!> \return ... !> \par History !> 09.2006 created [Joost VandeVondele] !> \note diff --git a/src/common/string_utilities.F b/src/common/string_utilities.F index 9a3117ce14..6717d0c066 100644 --- a/src/common/string_utilities.F +++ b/src/common/string_utilities.F @@ -99,7 +99,7 @@ CONTAINS !> It is case sensitive, apart from typos. !> \param string ... !> \param typo_string ... -!> \retval match ... +!> \return ... !> \par History !> 02.2006 created [Joost VandeVondele] !> \note @@ -153,7 +153,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Converts a character-array into a string !> \param array ... -!> \retval string ... +!> \return ... !> \par History !> 10.2013 created [Ole Schuett] ! ************************************************************************************************** @@ -172,7 +172,7 @@ CONTAINS !> \brief converts a bunch of strings of different length to an array of !> strings of the same length !> \param s1 ... -!> \retval a ... +!> \return ... !> \par History !> 11.2004 created [Joost VandeVondele ] !> \note @@ -190,7 +190,7 @@ CONTAINS !> \brief ... !> \param s1 ... !> \param s2 ... -!> \retval a ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION s2a_2(s1, s2) RESULT(a) CHARACTER(LEN=*), INTENT(IN) :: s1, s2 @@ -204,7 +204,7 @@ CONTAINS !> \param s1 ... !> \param s2 ... !> \param s3 ... -!> \retval a ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION s2a_3(s1, s2, s3) RESULT(a) CHARACTER(LEN=*), INTENT(IN) :: s1, s2, s3 @@ -219,7 +219,7 @@ CONTAINS !> \param s2 ... !> \param s3 ... !> \param s4 ... -!> \retval a ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION s2a_4(s1, s2, s3, s4) RESULT(a) CHARACTER(LEN=*), INTENT(IN) :: s1, s2, s3, s4 @@ -235,7 +235,7 @@ CONTAINS !> \param s3 ... !> \param s4 ... !> \param s5 ... -!> \retval a ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION s2a_5(s1, s2, s3, s4, s5) RESULT(a) CHARACTER(LEN=*), INTENT(IN) :: s1, s2, s3, s4, s5 @@ -252,7 +252,7 @@ CONTAINS !> \param s4 ... !> \param s5 ... !> \param s6 ... -!> \retval a ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION s2a_6(s1, s2, s3, s4, s5, s6) RESULT(a) CHARACTER(LEN=*), INTENT(IN) :: s1, s2, s3, s4, s5, s6 @@ -270,7 +270,7 @@ CONTAINS !> \param s5 ... !> \param s6 ... !> \param s7 ... -!> \retval a ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION s2a_7(s1, s2, s3, s4, s5, s6, s7) RESULT(a) CHARACTER(LEN=*), INTENT(IN) :: s1, s2, s3, s4, s5, s6, s7 @@ -289,7 +289,7 @@ CONTAINS !> \param s6 ... !> \param s7 ... !> \param s8 ... -!> \retval a ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION s2a_8(s1, s2, s3, s4, s5, s6, s7, s8) RESULT(a) CHARACTER(LEN=*), INTENT(IN) :: s1, s2, s3, s4, s5, s6, s7, s8 @@ -310,7 +310,7 @@ CONTAINS !> \param s7 ... !> \param s8 ... !> \param s9 ... -!> \retval a ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION s2a_9(s1, s2, s3, s4, s5, s6, s7, s8, s9) RESULT(a) CHARACTER(LEN=*), INTENT(IN) :: s1, s2, s3, s4, s5, s6, s7, s8, s9 @@ -332,7 +332,7 @@ CONTAINS !> \param s8 ... !> \param s9 ... !> \param s10 ... -!> \retval a ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION s2a_10(s1, s2, s3, s4, s5, s6, s7, s8, s9, s10) RESULT(a) CHARACTER(LEN=*), INTENT(IN) :: s1, s2, s3, s4, s5, s6, s7, s8, s9, s10 @@ -355,7 +355,7 @@ CONTAINS !> \param s9 ... !> \param s10 ... !> \param s11 ... -!> \retval a ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION s2a_11(s1, s2, s3, s4, s5, s6, s7, s8, s9, s10, s11) RESULT(a) CHARACTER(LEN=*), INTENT(IN) :: s1, s2, s3, s4, s5, s6, s7, s8, s9, s10, & @@ -380,7 +380,7 @@ CONTAINS !> \param s10 ... !> \param s11 ... !> \param s12 ... -!> \retval a ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION s2a_12(s1, s2, s3, s4, s5, s6, s7, s8, s9, s10, s11, s12) RESULT(a) CHARACTER(LEN=*), INTENT(IN) :: s1, s2, s3, s4, s5, s6, s7, s8, s9, s10, & @@ -406,7 +406,7 @@ CONTAINS !> \param s11 ... !> \param s12 ... !> \param s13 ... -!> \retval a ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION s2a_13(s1, s2, s3, s4, s5, s6, s7, s8, s9, s10, s11, s12, s13) RESULT(a) CHARACTER(LEN=*), INTENT(IN) :: s1, s2, s3, s4, s5, s6, s7, s8, s9, s10, & @@ -433,7 +433,7 @@ CONTAINS !> \param s12 ... !> \param s13 ... !> \param s14 ... -!> \retval a ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION s2a_14(s1, s2, s3, s4, s5, s6, s7, s8, s9, s10, s11, s12, s13, s14) RESULT(a) CHARACTER(LEN=*), INTENT(IN) :: s1, s2, s3, s4, s5, s6, s7, s8, s9, s10, & @@ -461,7 +461,7 @@ CONTAINS !> \param s13 ... !> \param s14 ... !> \param s15 ... -!> \retval a ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION s2a_15(s1, s2, s3, s4, s5, s6, s7, s8, s9, s10, s11, s12, s13, s14, s15) RESULT(a) CHARACTER(LEN=*), INTENT(IN) :: s1, s2, s3, s4, s5, s6, s7, s8, s9, s10, & @@ -491,7 +491,7 @@ CONTAINS !> \param s14 ... !> \param s15 ... !> \param s16 ... -!> \retval a ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION s2a_16(s1, s2, s3, s4, s5, s6, s7, s8, s9, s10, s11, s12, s13, s14, s15, & s16) RESULT(a) @@ -523,7 +523,7 @@ CONTAINS !> \param s15 ... !> \param s16 ... !> \param s17 ... -!> \retval a ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION s2a_17(s1, s2, s3, s4, s5, s6, s7, s8, s9, s10, s11, s12, s13, s14, s15, & s16, s17) RESULT(a) @@ -556,7 +556,7 @@ CONTAINS !> \param s16 ... !> \param s17 ... !> \param s18 ... -!> \retval a ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION s2a_18(s1, s2, s3, s4, s5, s6, s7, s8, s9, s10, s11, s12, s13, s14, s15, & s16, s17, s18) RESULT(a) @@ -590,7 +590,7 @@ CONTAINS !> \param s17 ... !> \param s18 ... !> \param s19 ... -!> \retval a ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION s2a_19(s1, s2, s3, s4, s5, s6, s7, s8, s9, s10, s11, s12, s13, s14, s15, & s16, s17, s18, s19) RESULT(a) @@ -626,7 +626,7 @@ CONTAINS !> \param s18 ... !> \param s19 ... !> \param s20 ... -!> \retval a ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION s2a_20(s1, s2, s3, s4, s5, s6, s7, s8, s9, s10, s11, s12, s13, s14, s15, & s16, s17, s18, s19, s20) RESULT(a) @@ -663,7 +663,7 @@ CONTAINS !> \param s19 ... !> \param s20 ... !> \param s21 ... -!> \retval a ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION s2a_21(s1, s2, s3, s4, s5, s6, s7, s8, s9, s10, s11, s12, s13, s14, s15, & s16, s17, s18, s19, s20, s21) RESULT(a) @@ -702,7 +702,7 @@ CONTAINS !> \param s20 ... !> \param s21 ... !> \param s22 ... -!> \retval a ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION s2a_22(s1, s2, s3, s4, s5, s6, s7, s8, s9, s10, s11, s12, s13, s14, s15, & s16, s17, s18, s19, s20, s21, s22) RESULT(a) @@ -742,7 +742,7 @@ CONTAINS !> \param s21 ... !> \param s22 ... !> \param s23 ... -!> \retval a ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION s2a_23(s1, s2, s3, s4, s5, s6, s7, s8, s9, s10, s11, s12, s13, s14, s15, & s16, s17, s18, s19, s20, s21, s22, s23) RESULT(a) @@ -783,7 +783,7 @@ CONTAINS !> \param s22 ... !> \param s23 ... !> \param s24 ... -!> \retval a ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION s2a_24(s1, s2, s3, s4, s5, s6, s7, s8, s9, s10, s11, s12, s13, s14, s15, & s16, s17, s18, s19, s20, s21, s22, s23, s24) RESULT(a) @@ -825,7 +825,7 @@ CONTAINS !> \param s23 ... !> \param s24 ... !> \param s25 ... -!> \retval a ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION s2a_25(s1, s2, s3, s4, s5, s6, s7, s8, s9, s10, s11, s12, s13, s14, s15, & s16, s17, s18, s19, s20, s21, s22, s23, s24, s25) RESULT(a) @@ -868,7 +868,7 @@ CONTAINS !> \param s24 ... !> \param s25 ... !> \param s26 ... -!> \retval a ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION s2a_26(s1, s2, s3, s4, s5, s6, s7, s8, s9, s10, s11, s12, s13, s14, s15, & s16, s17, s18, s19, s20, s21, s22, s23, s24, s25, s26) RESULT(a) @@ -913,7 +913,7 @@ CONTAINS !> \param s25 ... !> \param s26 ... !> \param s27 ... -!> \retval a ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION s2a_27(s1, s2, s3, s4, s5, s6, s7, s8, s9, s10, s11, s12, s13, s14, s15, & s16, s17, s18, s19, s20, s21, s22, s23, s24, s25, s26, s27) RESULT(a) @@ -960,7 +960,7 @@ CONTAINS !> \param s26 ... !> \param s27 ... !> \param s28 ... -!> \retval a ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION s2a_28(s1, s2, s3, s4, s5, s6, s7, s8, s9, s10, s11, s12, s13, s14, s15, & s16, s17, s18, s19, s20, s21, s22, s23, s24, s25, s26, s27, s28) RESULT(a) @@ -1008,7 +1008,7 @@ CONTAINS !> \param s27 ... !> \param s28 ... !> \param s29 ... -!> \retval a ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION s2a_29(s1, s2, s3, s4, s5, s6, s7, s8, s9, s10, s11, s12, s13, s14, s15, & s16, s17, s18, s19, s20, s21, s22, s23, s24, s25, s26, s27, s28, s29) RESULT(a) @@ -1057,7 +1057,7 @@ CONTAINS !> \param s28 ... !> \param s29 ... !> \param s30 ... -!> \retval a ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION s2a_30(s1, s2, s3, s4, s5, s6, s7, s8, s9, s10, s11, s12, s13, s14, s15, & s16, s17, s18, s19, s20, s21, s22, s23, s24, s25, s26, s27, s28, s29, s30) RESULT(a) @@ -1107,7 +1107,7 @@ CONTAINS !> \param s29 ... !> \param s30 ... !> \param s31 ... -!> \retval a ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION s2a_31(s1, s2, s3, s4, s5, s6, s7, s8, s9, s10, s11, s12, s13, s14, s15, & s16, s17, s18, s19, s20, s21, s22, s23, s24, s25, s26, s27, s28, s29, s30, s31) RESULT(a) @@ -1158,7 +1158,7 @@ CONTAINS !> \param s30 ... !> \param s31 ... !> \param s32 ... -!> \retval a ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION s2a_32(s1, s2, s3, s4, s5, s6, s7, s8, s9, s10, s11, s12, s13, s14, s15, & s16, s17, s18, s19, s20, s21, s22, s23, s24, s25, s26, s27, s28, s29, s30, s31, s32) RESULT(a) @@ -1210,7 +1210,7 @@ CONTAINS !> \param s31 ... !> \param s32 ... !> \param s33 ... -!> \retval a ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION s2a_33(s1, s2, s3, s4, s5, s6, s7, s8, s9, s10, s11, s12, s13, s14, s15, & s16, s17, s18, s19, s20, s21, s22, s23, s24, s25, s26, s27, s28, s29, s30, s31, s32, & @@ -1266,7 +1266,7 @@ CONTAINS !> \param s32 ... !> \param s33 ... !> \param s34 ... -!> \retval a ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION s2a_34(s1, s2, s3, s4, s5, s6, s7, s8, s9, s10, s11, s12, s13, s14, s15, & s16, s17, s18, s19, s20, s21, s22, s23, s24, s25, s26, s27, s28, s29, s30, s31, s32, & @@ -1323,7 +1323,7 @@ CONTAINS !> \param s33 ... !> \param s34 ... !> \param s35 ... -!> \retval a ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION s2a_35(s1, s2, s3, s4, s5, s6, s7, s8, s9, s10, s11, s12, s13, s14, s15, & s16, s17, s18, s19, s20, s21, s22, s23, s24, s25, s26, s27, s28, s29, s30, s31, s32, & @@ -1381,7 +1381,7 @@ CONTAINS !> \param s34 ... !> \param s35 ... !> \param s36 ... -!> \retval a ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION s2a_36(s1, s2, s3, s4, s5, s6, s7, s8, s9, s10, s11, s12, s13, s14, s15, & s16, s17, s18, s19, s20, s21, s22, s23, s24, s25, s26, s27, s28, s29, s30, s31, s32, & @@ -1438,7 +1438,7 @@ CONTAINS !> \param s35 ... !> \param s36 ... !> \param s37 ... -!> \retval a ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION s2a_37(s1, s2, s3, s4, s5, s6, s7, s8, s9, s10, s11, s12, s13, s14, s15, & s16, s17, s18, s19, s20, s21, s22, s23, s24, s25, s26, s27, s28, s29, s30, s31, s32, & @@ -1496,7 +1496,7 @@ CONTAINS !> \param s36 ... !> \param s37 ... !> \param s38 ... -!> \retval a ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION s2a_38(s1, s2, s3, s4, s5, s6, s7, s8, s9, s10, s11, s12, s13, s14, s15, & s16, s17, s18, s19, s20, s21, s22, s23, s24, s25, s26, s27, s28, s29, s30, s31, s32, & @@ -1555,7 +1555,7 @@ CONTAINS !> \param s37 ... !> \param s38 ... !> \param s39 ... -!> \retval a ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION s2a_39(s1, s2, s3, s4, s5, s6, s7, s8, s9, s10, s11, s12, s13, s14, s15, & s16, s17, s18, s19, s20, s21, s22, s23, s24, s25, s26, s27, s28, s29, s30, s31, s32, & @@ -1718,7 +1718,7 @@ CONTAINS !> ltu is true. !> \param inp_string ... !> \param ltu ... -!> \retval out_string ... +!> \return ... !> \date 10.03.2005 !> \par History !> - Enable the use of HTML entity names (06.03.13,MK) @@ -1916,7 +1916,7 @@ CONTAINS !> \brief ... !> \param str1 ... !> \param str2 ... -!> \retval equal ... +!> \return ... ! ************************************************************************************************** FUNCTION str_comp(str1, str2) RESULT(equal) @@ -1937,7 +1937,7 @@ CONTAINS ! ************************************************************************************************** !> \brief returns .true. if the character passed is a whitespace char. !> \param testchar ... -!> \retval resval ... +!> \return ... !> \par History !> 02.2008 created, AK ! ************************************************************************************************** diff --git a/src/common/timings.F b/src/common/timings.F index f6dff57e30..6867acb1c2 100644 --- a/src/common/timings.F +++ b/src/common/timings.F @@ -138,7 +138,7 @@ CONTAINS ! ************************************************************************************************** !> \brief returns the current timer env from the stack -!> \retval timer_env ... +!> \return ... !> \author fawzi ! ************************************************************************************************** FUNCTION get_timer_env() RESULT(timer_env) @@ -459,7 +459,7 @@ CONTAINS !> If no routine with given name is found in timer_env%routine_names !> then a new entiry is created. !> \param routineN ... -!> \retval routine_id ... +!> \return ... !> \author Ole Schuett ! ************************************************************************************************** FUNCTION routine_name2id(routineN) RESULT(routine_id) diff --git a/src/common/util.F b/src/common/util.F index fe37abeb71..5296470639 100644 --- a/src/common/util.F +++ b/src/common/util.F @@ -50,7 +50,7 @@ CONTAINS !> of x was found. !> \param array ... !> \param x ... -!> \retval x_index ... +!> \return ... !> \par History !> Derived from the locate function described in !> Numerical Recipes in Fortran 90 (09.01.2004,MK) @@ -203,7 +203,7 @@ CONTAINS !> \param m ... !> \param n ... !> \param me ... -!> \retval nlim ... +!> \return ... ! ************************************************************************************************** FUNCTION get_limit(m, n, me) RESULT(nlim) INTEGER, INTENT(IN) :: m, n, me diff --git a/src/common/xml_parser.F b/src/common/xml_parser.F index d90376cc90..f7434831fb 100644 --- a/src/common/xml_parser.F +++ b/src/common/xml_parser.F @@ -853,7 +853,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Function that returns whether all was okay or not !> \param info Structure holding information on the XML-file -!> \retval xml_ok .true. if there was no error, .false. otherwise +!> \return .true. if there was no error, .false. otherwise ! ************************************************************************************************** LOGICAL FUNCTION xml_ok(info) TYPE(XML_PARSE), INTENT(in) :: info @@ -867,7 +867,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Function that returns whether there was an error !> \param info Structure holding information on the XML-file -!> \retval xml_error .true. if there was an error, .false. if there was none +!> \return .true. if there was an error, .false. if there was none ! ************************************************************************************************** LOGICAL FUNCTION xml_error(info) TYPE(XML_PARSE), INTENT(in) :: info @@ -880,7 +880,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Function that returns whether data were truncated or not !> \param info Structure holding information on the XML-file -!> \retval xml_data_trunc .true. if data were truncated, .false. otherwise +!> \return .true. if data were truncated, .false. otherwise ! ************************************************************************************************** LOGICAL FUNCTION xml_data_trunc(info) TYPE(XML_PARSE), INTENT(in) :: info @@ -894,7 +894,7 @@ CONTAINS !> \param no_attribs ... !> \param name ... !> \param value ... -!> \retval xml_find_attrib ... +!> \return ... ! ************************************************************************************************** INTEGER FUNCTION xml_find_attrib(attribs, no_attribs, name, value) CHARACTER(len=*), DIMENSION(:, :) :: attribs diff --git a/src/constraint_clv.F b/src/constraint_clv.F index c2b3864963..9dfa9897fe 100644 --- a/src/constraint_clv.F +++ b/src/constraint_clv.F @@ -915,7 +915,7 @@ CONTAINS !> \param roll ... !> \param rmat ... !> \param imass ... -!> \retval res ... +!> \return ... !> \par History !> Teodoro Laino [teo] created 04.2006 !> \author Teodoro Laino [tlaino] @@ -966,7 +966,7 @@ CONTAINS !> \param veps ... !> \param rmat ... !> \param particles ... -!> \retval res ... +!> \return ... !> \par History !> Teodoro Laino [teo] created 04.2006 !> \author Teodoro Laino [tlaino] diff --git a/src/cp2k_info.F b/src/cp2k_info.F index b53edec83b..578e7f6e57 100644 --- a/src/cp2k_info.F +++ b/src/cp2k_info.F @@ -81,7 +81,7 @@ CONTAINS ! ************************************************************************************************** !> \brief list all compile time options that influence the capabilities of cp2k. !> All new flags should be added here (and be unique grep-able) -!> \retval flags ... +!> \return ... ! ************************************************************************************************** FUNCTION cp2k_flags() RESULT(flags) CHARACTER(len=10*default_string_length) :: flags diff --git a/src/cryssym.F b/src/cryssym.F index 27c0345c0b..dc0024bcb6 100644 --- a/src/cryssym.F +++ b/src/cryssym.F @@ -446,7 +446,7 @@ CONTAINS !> \brief ... !> \param x ... !> \param r ... -!> \retval y ... +!> \return ... ! ************************************************************************************************** FUNCTION kp_apply_operation(x, r) RESULT(y) REAL(KIND=dp), INTENT(IN) :: x(3) diff --git a/src/csvr_system_utils.F b/src/csvr_system_utils.F index f4d20d0dbd..03bf165eb9 100644 --- a/src/csvr_system_utils.F +++ b/src/csvr_system_utils.F @@ -72,7 +72,7 @@ CONTAINS !> \param ndeg ... !> \param taut ... !> \param rng_stream ... -!> \retval my_res ... +!> \return ... !> \date 09.2007 !> \author Giovanni Bussi - ETH Zurich, Lugano 10.2007 ! ************************************************************************************************** @@ -117,7 +117,7 @@ CONTAINS !> (i.e. equivalent to summing the square of the return values of nn calls to gasdev) !> \param nn ... !> \param rng_stream ... -!> \retval sum_gauss ... +!> \return ... !> \date 09.2007 !> \author Teo - University of Zurich ! ************************************************************************************************** diff --git a/src/d3_poly.F b/src/d3_poly.F index 97bf0d9f27..81c5b29d46 100644 --- a/src/d3_poly.F +++ b/src/d3_poly.F @@ -147,7 +147,7 @@ CONTAINS ! ************************************************************************************************** !> \brief size of a polynomial in x up to the given degree !> \param maxgrad ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION poly_size1(maxgrad) RESULT(res) INTEGER, INTENT(in) :: maxgrad @@ -159,7 +159,7 @@ CONTAINS ! ************************************************************************************************** !> \brief size of a polynomial in x,y up to the given degree !> \param maxgrad ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION poly_size2(maxgrad) RESULT(res) INTEGER, INTENT(in) :: maxgrad @@ -171,7 +171,7 @@ CONTAINS ! ************************************************************************************************** !> \brief size of a polynomial in x,y,z up to the given degree !> \param maxgrad ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION poly_size3(maxgrad) RESULT(res) INTEGER, INTENT(in) :: maxgrad @@ -183,7 +183,7 @@ CONTAINS ! ************************************************************************************************** !> \brief max grad for a polynom of the given size !> \param n ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION grad_size1(n) RESULT(res) INTEGER, INTENT(in) :: n @@ -195,7 +195,7 @@ CONTAINS ! ************************************************************************************************** !> \brief max grad for a polynom of the given size !> \param n ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION grad_size2(n) RESULT(res) INTEGER, INTENT(in) :: n @@ -207,7 +207,7 @@ CONTAINS ! ************************************************************************************************** !> \brief max grad for a polynom of the given size !> \param n ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION grad_size3(n) RESULT(res) INTEGER, INTENT(in) :: n @@ -228,7 +228,7 @@ CONTAINS ! ************************************************************************************************** !> \brief 0-based index of monomial of the given degree !> \param i ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION mono_index1(i) RESULT(res) INTEGER, INTENT(in) :: i @@ -241,7 +241,7 @@ CONTAINS !> \brief 0-based index of monomial of the given degree !> \param i ... !> \param j ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION mono_index2(i, j) RESULT(res) INTEGER, INTENT(in) :: i, j @@ -258,7 +258,7 @@ CONTAINS !> \param i ... !> \param j ... !> \param k ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION mono_index3(i, j, k) RESULT(res) INTEGER, INTENT(in) :: i, j, k @@ -274,7 +274,7 @@ CONTAINS ! ************************************************************************************************** !> \brief exponents of the monomial at the given 0-based index !> \param ii ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION mono_exp1(ii) RESULT(res) INTEGER, INTENT(in) :: ii @@ -286,7 +286,7 @@ CONTAINS ! ************************************************************************************************** !> \brief exponents of the monomial at the given 0-based index !> \param ii ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION mono_exp2(ii) RESULT(res) INTEGER, INTENT(in) :: ii @@ -302,7 +302,7 @@ CONTAINS ! ************************************************************************************************** !> \brief exponents of the monomial at the given 0-based index !> \param n ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION mono_exp3(n) RESULT(res) INTEGER, INTENT(in) :: n @@ -325,7 +325,7 @@ CONTAINS !> \brief the index of the result of the multiplication of the two monomials !> \param ii ... !> \param ij ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION mono_mult1(ii, ij) RESULT(res) INTEGER, INTENT(in) :: ii, ij @@ -338,7 +338,7 @@ CONTAINS !> \brief the index of the result of the multiplication of the two monomials !> \param ii ... !> \param ij ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION mono_mult2(ii, ij) RESULT(res) INTEGER, INTENT(in) :: ii, ij @@ -354,7 +354,7 @@ CONTAINS !> \brief the index of the result of the multiplication of the two monomials !> \param ii ... !> \param ij ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION mono_mult3(ii, ij) RESULT(res) INTEGER, INTENT(in) :: ii, ij @@ -822,7 +822,7 @@ CONTAINS !> \param p ... !> \param maxSize ... !> \param minSize ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** FUNCTION poly_random(p, maxSize, minSize) RESULT(res) REAL(dp), DIMENSION(:), INTENT(out) :: p diff --git a/src/dbcsr/base/array_types.F b/src/dbcsr/base/array_types.F index e492f8afdf..3f8d1d3a30 100644 --- a/src/dbcsr/base/array_types.F +++ b/src/dbcsr/base/array_types.F @@ -154,7 +154,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param array ... -!> \retval array_exists ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION array_exists_i1d(array) RESULT(array_exists) TYPE(array_i1d_obj), INTENT(IN) :: array @@ -166,7 +166,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param array ... -!> \retval DATA ... +!> \return ... ! ************************************************************************************************** FUNCTION array_data_i1d(array) RESULT(DATA) TYPE(array_i1d_obj), INTENT(IN) :: array @@ -181,7 +181,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param array ... -!> \retval the_size ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION array_size_i1d(array) RESULT(the_size) TYPE(array_i1d_obj), INTENT(IN) :: array @@ -197,7 +197,7 @@ CONTAINS !> \brief ... !> \param array1 ... !> \param array2 ... -!> \retval are_equal ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION array_equality_i1(array1, array2) RESULT(are_equal) INTEGER, DIMENSION(:), POINTER :: array1, array2 @@ -213,7 +213,7 @@ CONTAINS !> \brief ... !> \param array1 ... !> \param array2 ... -!> \retval are_equal ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION array_equality_i1d(array1, array2) RESULT(are_equal) TYPE(array_i1d_obj), INTENT(IN) :: array1, array2 @@ -229,7 +229,7 @@ CONTAINS !> \brief ... !> \param array ... !> \param index1 ... -!> \retval value ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION array_get_i1d(array, index1) RESULT(value) TYPE(array_i1d_obj), INTENT(IN) :: array @@ -242,7 +242,7 @@ CONTAINS !> \brief ... !> \param array ... !> \param index1 ... -!> \retval value ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION array_get_i1(array, index1) RESULT(value) INTEGER, DIMENSION(:), INTENT(IN), POINTER :: array diff --git a/src/dbcsr/base/btree.F b/src/dbcsr/base/btree.F index bd9153de67..b2a616c788 100644 --- a/src/dbcsr/base/btree.F +++ b/src/dbcsr/base/btree.F @@ -125,7 +125,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param tree ... -!> \retval num_entries ... +!> \return ... ! ************************************************************************************************** FUNCTION btree_get_entries_${nametype}$ (tree) RESULT (num_entries) TYPE(btree_${nametype}$), INTENT(INOUT) :: tree diff --git a/src/dbcsr/base/dbcsr_methods.F b/src/dbcsr/base/dbcsr_methods.F index dfdfc0d638..66782e7fa5 100644 --- a/src/dbcsr/base/dbcsr_methods.F +++ b/src/dbcsr/base/dbcsr_methods.F @@ -82,7 +82,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Returns whether the index structure of the matrix is valid. !> \param[in] matrix verify index validity of this matrix -!> \retval valid_index index validity +!> \return index validity ! ************************************************************************************************** PURE FUNCTION dbcsr_valid_index(matrix) RESULT(valid_index) TYPE(dbcsr_type), INTENT(IN) :: matrix @@ -292,7 +292,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param matrix ... -!> \retval nblkrows_total ... +!> \return ... ! ************************************************************************************************** FUNCTION dbcsr_nblkrows_total(matrix) RESULT(nblkrows_total) TYPE(dbcsr_type), INTENT(IN) :: matrix @@ -304,7 +304,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param matrix ... -!> \retval nblkcols_total ... +!> \return ... ! ************************************************************************************************** FUNCTION dbcsr_nblkcols_total(matrix) RESULT(nblkcols_total) TYPE(dbcsr_type), INTENT(IN) :: matrix @@ -315,7 +315,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param matrix ... -!> \retval nfullrows_total ... +!> \return ... ! ************************************************************************************************** FUNCTION dbcsr_nfullrows_total(matrix) RESULT(nfullrows_total) TYPE(dbcsr_type), INTENT(IN) :: matrix @@ -326,7 +326,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param matrix ... -!> \retval nfullcols_total ... +!> \return ... ! ************************************************************************************************** FUNCTION dbcsr_nfullcols_total(matrix) RESULT(nfullcols_total) TYPE(dbcsr_type), INTENT(IN) :: matrix @@ -337,7 +337,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param matrix ... -!> \retval nblkrows_local ... +!> \return ... ! ************************************************************************************************** FUNCTION dbcsr_nblkrows_local(matrix) RESULT(nblkrows_local) TYPE(dbcsr_type), INTENT(IN) :: matrix @@ -348,7 +348,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param matrix ... -!> \retval nblkcols_local ... +!> \return ... ! ************************************************************************************************** FUNCTION dbcsr_nblkcols_local(matrix) RESULT(nblkcols_local) TYPE(dbcsr_type), INTENT(IN) :: matrix @@ -359,7 +359,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param matrix ... -!> \retval nfullrows_local ... +!> \return ... ! ************************************************************************************************** FUNCTION dbcsr_nfullrows_local(matrix) RESULT(nfullrows_local) TYPE(dbcsr_type), INTENT(IN) :: matrix @@ -370,7 +370,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param matrix ... -!> \retval nfullcols_local ... +!> \return ... ! ************************************************************************************************** FUNCTION dbcsr_nfullcols_local(matrix) RESULT(nfullcols_local) TYPE(dbcsr_type), INTENT(IN) :: matrix @@ -381,7 +381,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param matrix ... -!> \retval max_row_size ... +!> \return ... ! ************************************************************************************************** FUNCTION dbcsr_max_row_size(matrix) RESULT(max_row_size) TYPE(dbcsr_type), INTENT(IN) :: matrix @@ -392,7 +392,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param matrix ... -!> \retval max_col_size ... +!> \return ... ! ************************************************************************************************** FUNCTION dbcsr_max_col_size(matrix) RESULT(max_col_size) TYPE(dbcsr_type), INTENT(IN) :: matrix @@ -404,7 +404,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param matrix ... -!> \retval distribution ... +!> \return ... ! ************************************************************************************************** FUNCTION dbcsr_distribution(matrix) RESULT(distribution) TYPE(dbcsr_type), INTENT(IN) :: matrix @@ -416,7 +416,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param matrix ... -!> \retval name ... +!> \return ... ! ************************************************************************************************** FUNCTION dbcsr_name(matrix) RESULT(name) TYPE(dbcsr_type), INTENT(IN) :: matrix @@ -429,7 +429,7 @@ CONTAINS !> \brief ... !> \param matrix ... !> \param newname ... -!> \retval name ... +!> \return ... ! ************************************************************************************************** SUBROUTINE dbcsr_setname(matrix, newname) @@ -442,7 +442,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Returns whether this work matrix uses the mutable type !> \param[in] wm work matrix -!> \retval use_mutable use the mutable and not append-only working +!> \return use the mutable and not append-only working !> structures ! ************************************************************************************************** PURE FUNCTION dbcsr_wm_use_mutable(wm) RESULT(use_mutable) @@ -457,7 +457,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Returns whether work matrices should use the mutable data type !> \param[in] matrix matrix -!> \retval use_mutable use the mutable and not append-only working +!> \return use the mutable and not append-only working !> structures ! ************************************************************************************************** PURE FUNCTION dbcsr_use_mutable(matrix) RESULT(use_mutable) @@ -472,7 +472,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param matrix ... -!> \retval row_blk_sizes ... +!> \return ... ! ************************************************************************************************** FUNCTION dbcsr_row_block_sizes(matrix) RESULT(row_blk_sizes) TYPE(dbcsr_type), INTENT(IN) :: matrix @@ -484,7 +484,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param matrix ... -!> \retval col_blk_sizes ... +!> \return ... ! ************************************************************************************************** FUNCTION dbcsr_col_block_sizes(matrix) RESULT(col_blk_sizes) TYPE(dbcsr_type), INTENT(IN) :: matrix @@ -496,7 +496,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param matrix ... -!> \retval col_blk_offsets ... +!> \return ... ! ************************************************************************************************** FUNCTION dbcsr_col_block_offsets(matrix) RESULT(col_blk_offsets) TYPE(dbcsr_type), INTENT(IN) :: matrix @@ -508,7 +508,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param matrix ... -!> \retval row_blk_offsets ... +!> \return ... ! ************************************************************************************************** FUNCTION dbcsr_row_block_offsets(matrix) RESULT(row_blk_offsets) TYPE(dbcsr_type), INTENT(IN) :: matrix @@ -523,7 +523,7 @@ CONTAINS !> This routine is optimized for speed and no checks are performed. !> \param[in] matrix DBCSR matrix !> \param[in] row row number -!> \retval row_size blocked row size +!> \return blocked row size ! ************************************************************************************************** PURE FUNCTION dbcsr_blk_row_size(matrix, row) RESULT(row_size) TYPE(dbcsr_type), INTENT(IN) :: matrix @@ -537,7 +537,7 @@ CONTAINS !> \brief ... !> \param matrix ... !> \param row ... -!> \retval row_offset ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION dbcsr_blk_row_offset(matrix, row) RESULT(row_offset) TYPE(dbcsr_type), INTENT(IN) :: matrix @@ -553,7 +553,7 @@ CONTAINS !> This routine is optimized for speed and no checks are performed. !> \param[in] matrix DBCSR matrix !> \param[in] column column number -!> \retval column_size blocked row size +!> \return blocked row size ! ************************************************************************************************** PURE FUNCTION dbcsr_blk_column_size(matrix, column) RESULT(column_size) TYPE(dbcsr_type), INTENT(IN) :: matrix @@ -567,7 +567,7 @@ CONTAINS !> \brief ... !> \param matrix ... !> \param col ... -!> \retval col_offset ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION dbcsr_blk_col_offset(matrix, col) RESULT(col_offset) TYPE(dbcsr_type), INTENT(IN) :: matrix @@ -580,7 +580,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Returns the data area !> \param matrix matrix from which to get data -!> \retval data_area data area +!> \return data area ! ************************************************************************************************** FUNCTION dbcsr_data_area(matrix) RESULT(data_area) TYPE(dbcsr_type), INTENT(IN) :: matrix @@ -592,7 +592,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Returns the matrix type !> \param matrix query this matrix -!> \retval matrix_type matrix_type (see dbcsr_types.F for possible +!> \return matrix_type (see dbcsr_types.F for possible !> values) ! ************************************************************************************************** PURE FUNCTION dbcsr_get_matrix_type(matrix) RESULT(matrix_type) @@ -618,7 +618,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Whether matrix has symmetry !> \param matrix query this matrix -!> \retval has_symmetry matrix has symmetry +!> \return matrix has symmetry ! ************************************************************************************************** PURE FUNCTION dbcsr_has_symmetry(matrix) RESULT(has_symmetry) TYPE(dbcsr_type), INTENT(IN) :: matrix @@ -630,7 +630,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Returns the data type stored in the matrix !> \param matrix query this matrix -!> \retval repl_type repl_type (see dbcsr_types.F for possible +!> \return repl_type (see dbcsr_types.F for possible !> values) ! ************************************************************************************************** @@ -644,7 +644,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Returns the data type stored in the matrix !> \param matrix query this matrix -!> \retval data_type data_type (see dbcsr_types.F for possible +!> \return data_type (see dbcsr_types.F for possible !> values) ! ************************************************************************************************** PURE FUNCTION dbcsr_get_data_type(matrix) RESULT(data_type) @@ -657,7 +657,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Returns the type of memory used for data in the matrix !> \param[in] matrix query this matrix -!> \retval memory_type memory type used for data +!> \return memory type used for data !> \note It returns the declared data type, not the actually used type ! ************************************************************************************************** FUNCTION dbcsr_get_data_memory_type(matrix) & @@ -671,7 +671,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Returns the type of memory used for the index in the matrix !> \param[in] matrix query this matrix -!> \retval memory_type memory type used for the index +!> \return memory type used for the index ! ************************************************************************************************** FUNCTION dbcsr_get_index_memory_type(matrix) RESULT(memory_type) TYPE(dbcsr_type), INTENT(IN) :: matrix @@ -715,7 +715,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Returns the allocated data size of a DBCSR matrix !> \param[in] matrix matrix -!> \retval data_size size of data +!> \return size of data ! ************************************************************************************************** FUNCTION dbcsr_get_data_size(matrix) RESULT(data_size) TYPE(dbcsr_type), INTENT(IN) :: matrix @@ -738,7 +738,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Count actual data storage used for matrix data. !> \param[in] matrix Count data of this matrix -!> \retval data_size Data size used by matrix +!> \return Data size used by matrix ! ************************************************************************************************** FUNCTION dbcsr_get_data_size_used(matrix) RESULT(data_size) TYPE(dbcsr_type), INTENT(IN) :: matrix @@ -774,7 +774,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Returns the number of blocks in the matrix !> \param matrix matrix from which to get data -!> \retval num_blocks ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION dbcsr_get_num_blocks(matrix) RESULT(num_blocks) TYPE(dbcsr_type), INTENT(IN) :: matrix @@ -786,7 +786,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Returns the number of non-zero elements in the matrix !> \param matrix matrix from which to get data -!> \retval num_nze ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION dbcsr_get_nze(matrix) RESULT(num_nze) TYPE(dbcsr_type), INTENT(IN) :: matrix @@ -1024,7 +1024,7 @@ CONTAINS !> !> The object is destroy when there is no reference to it left. !> \param[in] mutable mutable data -!> \retval instantiated whether the object is instantiated +!> \return whether the object is instantiated ! ************************************************************************************************** PURE FUNCTION dbcsr_mutable_instantiated(mutable) RESULT(instantiated) TYPE(dbcsr_mutable_obj), INTENT(IN) :: mutable diff --git a/src/dbcsr/base/dbcsr_toollib.F b/src/dbcsr/base/dbcsr_toollib.F index 64ae9d6cce..bcd112573a 100644 --- a/src/dbcsr/base/dbcsr_toollib.F +++ b/src/dbcsr/base/dbcsr_toollib.F @@ -55,7 +55,7 @@ CONTAINS !> \brief ... !> \param most ... !> \param least ... -!> \retval tuple ... +!> \return ... ! ************************************************************************************************** ELEMENTAL FUNCTION make_coordinate_tuple(most, least) RESULT(tuple) INTEGER, INTENT(IN) :: most, least @@ -150,7 +150,7 @@ CONTAINS !> \brief ... !> \param a ... !> \param b ... -!> \retval gcd ... +!> \return ... ! ************************************************************************************************** ELEMENTAL FUNCTION gcd(a, b) INTEGER, INTENT(IN) :: a, b @@ -184,7 +184,7 @@ CONTAINS !> \brief ... !> \param a ... !> \param b ... -!> \retval lcm ... +!> \return ... ! ************************************************************************************************** ELEMENTAL FUNCTION lcm(a, b) INTEGER, INTENT(IN) :: a, b @@ -204,7 +204,7 @@ CONTAINS ! ************************************************************************************************** !> \brief generates the hash of a string and the index in the table !> \param key a string of any length -!> \retval hash_index ... +!> \return ... !> \par History !> 09.2006 created [Joost VandeVondele] !> 2010-11-23 copied from CP2K and converted to take integers @@ -249,7 +249,7 @@ CONTAINS !> \param found ... !> \param lb ... !> \param ub ... -!> \retval hash_index ... +!> \return ... !> \par History !> 04.2015 created [Alfio Lazzaro] ! ************************************************************************************************** diff --git a/src/dbcsr/base/hash_table.f90 b/src/dbcsr/base/hash_table.f90 index 348d579579..8e13df3a67 100644 --- a/src/dbcsr/base/hash_table.f90 +++ b/src/dbcsr/base/hash_table.f90 @@ -9,7 +9,7 @@ ! ***************************************************************************** !> \brief finds a prime equal or larger than i, needed at creation !> \param i ... -!> \retval res ... +!> \return ... ! ***************************************************************************** FUNCTION matching_prime(i) RESULT(res) INTEGER, INTENT(IN) :: i @@ -122,7 +122,7 @@ !> \brief ... !> \param hash_table ... !> \param c ... -!> \retval p ... +!> \return ... ! ***************************************************************************** PURE FUNCTION hash_table_get(hash_table,c) RESULT(p) TYPE(hash_table_type), INTENT(IN) :: hash_table diff --git a/src/dbcsr/block/dbcsr_index_operations.F b/src/dbcsr/block/dbcsr_index_operations.F index 0ee7a5e997..fa3c75f75b 100644 --- a/src/dbcsr/block/dbcsr_index_operations.F +++ b/src/dbcsr/block/dbcsr_index_operations.F @@ -1527,7 +1527,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param matrix ... -!> \retval local_indexing ... +!> \return ... ! ************************************************************************************************** FUNCTION dbcsr_has_local_row_index(matrix) RESULT(local_indexing) TYPE(dbcsr_type), INTENT(INOUT) :: matrix diff --git a/src/dbcsr/block/dbcsr_iterator_operations.F b/src/dbcsr/block/dbcsr_iterator_operations.F index bd7b5398b3..ed4766ed6b 100644 --- a/src/dbcsr/block/dbcsr_iterator_operations.F +++ b/src/dbcsr/block/dbcsr_iterator_operations.F @@ -753,7 +753,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Returns whether there any blocks left in the iterator. !> \param[in] iterator the iterator -!> \retval blocks_left ... +!> \return ... !> \param[in] ! ************************************************************************************************** PURE FUNCTION dbcsr_iterator_blocks_left(iterator) RESULT(blocks_left) diff --git a/src/dbcsr/block/dbcsr_work_operations.F b/src/dbcsr/block/dbcsr_work_operations.F index f2ec021d94..d7035ca9b9 100644 --- a/src/dbcsr/block/dbcsr_work_operations.F +++ b/src/dbcsr/block/dbcsr_work_operations.F @@ -1084,7 +1084,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Checks whether the matrix can be finalized with minimal copying. !> \param[in] matrix matrix to check -!> \retval quick whether matrix can be quickly finalized +!> \return whether matrix can be quickly finalized ! ************************************************************************************************** FUNCTION can_quickly_finalize(matrix) RESULT(quick) TYPE(dbcsr_type), INTENT(IN) :: matrix @@ -1338,7 +1338,7 @@ CONTAINS !> \param[in] row point to check !> \param[in] column point to check !> \param[in] limits limits (low_row, high_row, low_col, high_col) -!> \retval within_limits whether the point is within the bounds +!> \return whether the point is within the bounds ! ************************************************************************************************** PURE FUNCTION within_limits(row, column, limits) diff --git a/src/dbcsr/data/dbcsr_data_methods_low.F b/src/dbcsr/data/dbcsr_data_methods_low.F index 881bd5e9ed..e4fd7a0b0f 100644 --- a/src/dbcsr/data/dbcsr_data_methods_low.F +++ b/src/dbcsr/data/dbcsr_data_methods_low.F @@ -111,7 +111,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Returns data type of a data area !> \param[in] area data area -!> \retval data_type data type of the data area +!> \return data type of the data area ! ************************************************************************************************** PURE FUNCTION dbcsr_data_get_type(area) RESULT(data_type) TYPE(dbcsr_data_obj), INTENT(IN) :: area @@ -123,7 +123,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Returns if there is a single reference of the data !> \param[in] area data area -!> \retval unique true if reference is 1 +!> \return true if reference is 1 ! ************************************************************************************************** PURE FUNCTION dbcsr_data_unique(area) RESULT(unique) TYPE(dbcsr_data_obj), INTENT(IN) :: area @@ -135,7 +135,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param area ... -!> \retval memory_type ... +!> \return ... ! ************************************************************************************************** FUNCTION dbcsr_data_get_memory_type(area) RESULT(memory_type) TYPE(dbcsr_data_obj), INTENT(IN) :: area @@ -331,7 +331,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Checks whether a data area is valid !> \param[in] area data area -!> \retval valid whether the data area is valid +!> \return whether the data area is valid ! ************************************************************************************************** ELEMENTAL FUNCTION dbcsr_data_valid(area) RESULT(valid) TYPE(dbcsr_data_obj), INTENT(IN) :: area @@ -348,7 +348,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Checks whether a data pointer exists !> \param[in] area data area -!> \retval valid whether the data pointer exists +!> \return whether the data pointer exists ! ************************************************************************************************** FUNCTION dbcsr_data_exists(area) RESULT(valid) TYPE(dbcsr_data_obj), INTENT(IN) :: area @@ -540,7 +540,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Returns the allocated data size !> \param[in] area data area -!> \retval data_size size of data +!> \return size of data ! ************************************************************************************************** FUNCTION dbcsr_data_get_size(area) RESULT(data_size) TYPE(dbcsr_data_obj), INTENT(IN) :: area @@ -849,7 +849,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Returns an encapsulated scalar "1" !> \param[in] data_type use the data type -!> \retval one encapsulated value of one +!> \return encapsulated value of one ! ************************************************************************************************** ELEMENTAL FUNCTION dbcsr_scalar_one(data_type) RESULT(one) INTEGER, INTENT(IN) :: data_type @@ -871,7 +871,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Returns an encapsulated scalar "sqrt(-1)" !> \param[in] data_type use the data type -!> \retval i encapsulated value of i +!> \return encapsulated value of i ! ************************************************************************************************** ELEMENTAL FUNCTION dbcsr_scalar_i(data_type) RESULT(i) INTEGER, INTENT(IN) :: data_type @@ -893,7 +893,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Returns an encapsulated scalar "0" !> \param[in] data_type use the data type -!> \retval zero encapsulated value of zero +!> \return encapsulated value of zero ! ************************************************************************************************** ELEMENTAL FUNCTION dbcsr_scalar_zero(data_type) RESULT(zero) INTEGER, INTENT(IN) :: data_type @@ -910,7 +910,7 @@ CONTAINS !> \brief Returns whether an encapsulated scalar is equal to another value !> \param[in] s1 one value !> \param[in] s2 another value -!> \retval are_equal whether values are equal +!> \return whether values are equal ! ************************************************************************************************** ELEMENTAL FUNCTION dbcsr_scalar_are_equal(s1, s2) RESULT(are_equal) TYPE(dbcsr_scalar_type), INTENT(IN) :: s1, s2 @@ -937,7 +937,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Returns an encapsulated scalar as a negation of the given !> \param[in] s given value -!> \retval negated negated value +!> \return negated value ! ************************************************************************************************** ELEMENTAL FUNCTION dbcsr_scalar_negative(s) RESULT(negated) TYPE(dbcsr_scalar_type), INTENT(IN) :: s @@ -962,7 +962,7 @@ CONTAINS !> \brief Returns an encapsulated scalar as a negation of the given !> \param s1 ... !> \param s2 ... -!> \retval s_sum ... +!> \return ... ! ************************************************************************************************** ELEMENTAL FUNCTION dbcsr_scalar_add(s1, s2) RESULT(s_sum) TYPE(dbcsr_scalar_type), INTENT(IN) :: s1, s2 @@ -987,7 +987,7 @@ CONTAINS !> \brief ... !> \param s1 ... !> \param s2 ... -!> \retval s_product ... +!> \return ... ! ************************************************************************************************** ELEMENTAL FUNCTION dbcsr_scalar_multiply(s1, s2) RESULT(s_product) TYPE(dbcsr_scalar_type), INTENT(IN) :: s1, s2 @@ -1011,7 +1011,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Returns data type of a scalar !> \param[in] scalar scalar -!> \retval data_type data type of the scalar +!> \return data type of the scalar ! ************************************************************************************************** ELEMENTAL FUNCTION dbcsr_scalar_get_type(scalar) RESULT(data_type) TYPE(dbcsr_scalar_type), INTENT(IN) :: scalar @@ -1066,7 +1066,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Checks whether the data type is 2-D. !> \param data_type ... -!> \retval dbcsr_type_is_2d Data type is 2-D. +!> \return Data type is 2-D. ! ************************************************************************************************** PURE FUNCTION dbcsr_type_is_2d(data_type) INTEGER, INTENT(IN) :: data_type @@ -1081,7 +1081,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Returns 1-d data type corresponding to the given 2-D one. !> \param data_type ... -!> \retval dbcsr_type_2d_to_1d 1-D data type +!> \return 1-D data type ! ************************************************************************************************** PURE FUNCTION dbcsr_type_2d_to_1d(data_type) INTEGER, INTENT(IN) :: data_type @@ -1112,7 +1112,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Returns 2-D data type corresponding to the given 1-D one. !> \param data_type ... -!> \retval dbcsr_type_1d_to_2d 2-D data type +!> \return 2-D data type ! ************************************************************************************************** PURE FUNCTION dbcsr_type_1d_to_2d(data_type) INTEGER, INTENT(IN) :: data_type @@ -1143,7 +1143,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Get actual data storage used for matrix !> \param[in] area Count data of this matrix -!> \retval data_size_referenced Data size used by matrix +!> \return Data size used by matrix ! ************************************************************************************************** PURE FUNCTION dbcsr_data_get_size_referenced(area) RESULT(data_size_referenced) TYPE(dbcsr_data_obj), INTENT(IN) :: area diff --git a/src/dbcsr/data/dbcsr_data_methods_low.f90 b/src/dbcsr/data/dbcsr_data_methods_low.f90 index 9075311083..73e0b47bde 100644 --- a/src/dbcsr/data/dbcsr_data_methods_low.f90 +++ b/src/dbcsr/data/dbcsr_data_methods_low.f90 @@ -57,7 +57,7 @@ !> \param[in] select_data_type force datatype !> \param[in] lb (optional) lower bound for pointer !> \param[in] ub (optional) upper bound for pointer -!> \retval data pointer to data +!> \return pointer to data !> \par Calling !> This routine is hidden behind the dbcsr_get_data interface, hence the !> need for the select_data_type argument. @@ -110,7 +110,7 @@ !> \param[in] area data area !> \param[in] lb (optional) lower bound for pointer !> \param[in] ub (optional) upper bound for pointer -!> \retval DATA pointer to data +!> \return pointer to data !> \par Calling !> This routine can be called explicitly. ! ************************************************************************************************** @@ -154,7 +154,7 @@ !> \param[in] area data area !> \param[in] lb (optional) lower bound for pointer !> \param[in] ub (optional) upper bound for pointer -!> \retval DATA pointer to data +!> \return pointer to data !> \par Calling !> This routine can be called explicitly. ! ************************************************************************************************** @@ -288,7 +288,7 @@ ! ************************************************************************************************** !> \brief Sets a scalar in an encapsulated data structure !> \param[in] scalar scalar to encapsulate -!> \retval encapsulated_scalar encapsulated scalar +!> \return encapsulated scalar ! ************************************************************************************************** ELEMENTAL FUNCTION dbcsr_scalar_${nametype1}$ (scalar) RESULT (encapsulated_scalar) ${type1}$, INTENT(IN) :: scalar diff --git a/src/dbcsr/data/dbcsr_data_types.F b/src/dbcsr/data/dbcsr_data_types.F index 6f454cf0fb..a4a9d936eb 100644 --- a/src/dbcsr/data/dbcsr_data_types.F +++ b/src/dbcsr/data/dbcsr_data_types.F @@ -144,7 +144,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Helper-routine, returns size of given datatype in terms of bytes. !> \param datatype ... -!> \retval size ... +!> \return ... !> \author Ole Schuett ! ************************************************************************************************** FUNCTION dbcsr_datatype_sizeof(datatype) RESULT(size) diff --git a/src/dbcsr/data/dbcsr_mem_methods.F b/src/dbcsr/data/dbcsr_mem_methods.F index d0f349b5c5..9e65e44e16 100644 --- a/src/dbcsr/data/dbcsr_mem_methods.F +++ b/src/dbcsr/data/dbcsr_mem_methods.F @@ -82,7 +82,7 @@ CONTAINS !> \param memtype ... !> \param datatype ... !> \param datasize ... -!> \retval res ... +!> \return ... !> \author Ole Schuett ! ************************************************************************************************** FUNCTION dbcsr_mempool_get(memtype, datatype, datasize) RESULT(res) @@ -318,7 +318,7 @@ CONTAINS !> \brief Test if two memtypes are equal !> \param mt1 ... !> \param mt2 ... -!> \retval res ... +!> \return ... !> \author Ole Schuett ! ************************************************************************************************** FUNCTION dbcsr_memtype_equal(mt1, mt2) RESULT(res) diff --git a/src/dbcsr/data/dbcsr_ptr_util.F b/src/dbcsr/data/dbcsr_ptr_util.F index a371eee6ec..ba6475617a 100644 --- a/src/dbcsr/data/dbcsr_ptr_util.F +++ b/src/dbcsr/data/dbcsr_ptr_util.F @@ -105,7 +105,7 @@ CONTAINS !> \param[in] area area to point into !> \param[in] offset point to this offset in area !> \param[in] len (optional) length of data area to point to -!> \retval narea2 copy of new_area +!> \return copy of new_area ! ************************************************************************************************** FUNCTION pointer_view_a(new_area, area, offset, len) RESULT(narea2) TYPE(dbcsr_data_obj), INTENT(INOUT) :: new_area diff --git a/src/dbcsr/data/dbcsr_ptr_util.f90 b/src/dbcsr/data/dbcsr_ptr_util.f90 index 320dfffdf9..fdb2df485a 100644 --- a/src/dbcsr/data/dbcsr_ptr_util.f90 +++ b/src/dbcsr/data/dbcsr_ptr_util.f90 @@ -10,7 +10,7 @@ !> \param[in] original original data pointer !> \param[in] lb lower and upper bound for the new pointer view !> \param[in] ub lower and upper bound for the new pointer view -!> \retval view new pointer +!> \return new pointer ! ************************************************************************************************** FUNCTION pointer_view_${nametype1}$ (original, lb, ub) RESULT (view) ${type1}$, DIMENSION(:), POINTER :: original, view diff --git a/src/dbcsr/dbcsr_api.F b/src/dbcsr/dbcsr_api.F index 48b628fd6e..4334e1ef5a 100644 --- a/src/dbcsr/dbcsr_api.F +++ b/src/dbcsr/dbcsr_api.F @@ -444,7 +444,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param matrix ... -!> \retval norm ... +!> \return ... ! ************************************************************************************************** FUNCTION dbcsr_gershgorin_norm(matrix) RESULT(norm) TYPE(dbcsr_type), INTENT(INOUT) :: matrix @@ -457,7 +457,7 @@ CONTAINS !> \brief ... !> \param matrix ... !> \param local ... -!> \retval norm ... +!> \return ... ! ************************************************************************************************** FUNCTION dbcsr_frobenius_norm(matrix, local) RESULT(norm) TYPE(dbcsr_type), INTENT(INOUT) :: matrix @@ -470,7 +470,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param matrix ... -!> \retval norm ... +!> \return ... ! ************************************************************************************************** FUNCTION dbcsr_maxabs(matrix) RESULT(norm) TYPE(dbcsr_type), INTENT(INOUT) :: matrix @@ -574,7 +574,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param matrix ... -!> \retval data_type ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION dbcsr_get_data_type(matrix) RESULT(data_type) TYPE(dbcsr_type), INTENT(IN) :: matrix @@ -586,7 +586,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param matrix ... -!> \retval valid_index ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION dbcsr_valid_index(matrix) RESULT(valid_index) TYPE(dbcsr_type), INTENT(IN) :: matrix @@ -613,7 +613,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param matrix ... -!> \retval num_blocks ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION dbcsr_get_num_blocks(matrix) RESULT(num_blocks) TYPE(dbcsr_type), INTENT(IN) :: matrix @@ -625,7 +625,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param matrix ... -!> \retval data_size ... +!> \return ... ! ************************************************************************************************** FUNCTION dbcsr_get_data_size(matrix) RESULT(data_size) TYPE(dbcsr_type), INTENT(IN) :: matrix @@ -637,7 +637,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param matrix ... -!> \retval matrix_type ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION dbcsr_get_matrix_type(matrix) RESULT(matrix_type) TYPE(dbcsr_type), INTENT(IN) :: matrix @@ -649,7 +649,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param matrix ... -!> \retval occupation ... +!> \return ... ! ************************************************************************************************** FUNCTION dbcsr_get_occupation(matrix) RESULT(occupation) TYPE(dbcsr_type), INTENT(IN) :: matrix @@ -661,7 +661,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param matrix ... -!> \retval nblkrows_total ... +!> \return ... ! ************************************************************************************************** FUNCTION dbcsr_nblkrows_total(matrix) RESULT(nblkrows_total) TYPE(dbcsr_type), INTENT(IN) :: matrix @@ -673,7 +673,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param matrix ... -!> \retval nblkcols_total ... +!> \return ... ! ************************************************************************************************** FUNCTION dbcsr_nblkcols_total(matrix) RESULT(nblkcols_total) TYPE(dbcsr_type), INTENT(IN) :: matrix @@ -685,7 +685,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param matrix ... -!> \retval nfullrows_total ... +!> \return ... ! ************************************************************************************************** FUNCTION dbcsr_nfullrows_total(matrix) RESULT(nfullrows_total) TYPE(dbcsr_type), INTENT(IN) :: matrix @@ -697,7 +697,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param matrix ... -!> \retval nfullcols_total ... +!> \return ... ! ************************************************************************************************** FUNCTION dbcsr_nfullcols_total(matrix) RESULT(nfullcols_total) TYPE(dbcsr_type), INTENT(IN) :: matrix @@ -709,7 +709,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param iterator ... -!> \retval blocks_left ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION dbcsr_iterator_blocks_left(iterator) RESULT(blocks_left) TYPE(dbcsr_iterator_type), INTENT(IN) :: iterator @@ -1049,7 +1049,7 @@ CONTAINS !> \param matrix ... !> \param local ... !> \param pos ... -!> \retval checksum ... +!> \return ... ! ************************************************************************************************** FUNCTION dbcsr_checksum(matrix, local, pos) RESULT(checksum) TYPE(dbcsr_type), INTENT(IN) :: matrix @@ -1694,7 +1694,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param matrix ... -!> \retval has_symmetry ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION dbcsr_has_symmetry(matrix) RESULT(has_symmetry) TYPE(dbcsr_type), INTENT(IN) :: matrix diff --git a/src/dbcsr/dbcsr_api.f90 b/src/dbcsr/dbcsr_api.f90 index f4af4939f0..5e6f81949b 100644 --- a/src/dbcsr/dbcsr_api.f90 +++ b/src/dbcsr/dbcsr_api.f90 @@ -10,7 +10,7 @@ !> type of the matrix. !> \param scalar ... !> \param matrix ... -!> \retval encapsulated ... +!> \return ... ! ************************************************************************************************** FUNCTION make_conformant_scalar_${nametype1}$ (scalar, matrix) RESULT (encapsulated) ${type1}$, INTENT(IN) :: scalar @@ -406,7 +406,7 @@ !> \param index_matrix ... !> \param lb ... !> \param ub ... -!> \retval DATA ... +!> \return ... ! ************************************************************************************************** FUNCTION dbcsr_get_wms_data_${nametype1}$ (matrix, index_matrix, select_data_type, lb, ub) RESULT (DATA) TYPE(dbcsr_type), INTENT(IN) :: matrix @@ -425,7 +425,7 @@ !> \param index_matrix ... !> \param lb ... !> \param ub ... -!> \retval DATA ... +!> \return ... ! ************************************************************************************************** FUNCTION dbcsr_get_data_${nametype1}$ (matrix, select_data_type, lb, ub) RESULT (DATA) TYPE(dbcsr_type), INTENT(IN) :: matrix diff --git a/src/dbcsr/dbcsr_performance_multiply.F b/src/dbcsr/dbcsr_performance_multiply.F index c101aca901..55934d8c7f 100644 --- a/src/dbcsr/dbcsr_performance_multiply.F +++ b/src/dbcsr/dbcsr_performance_multiply.F @@ -676,7 +676,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param v ... -!> \retval mean ... +!> \return ... ! ************************************************************************************************** FUNCTION mean(v) REAL(real_8), DIMENSION(:) :: v @@ -694,7 +694,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param v ... -!> \retval std ... +!> \return ... ! ************************************************************************************************** FUNCTION std(v) REAL(real_8), DIMENSION(:) :: v diff --git a/src/dbcsr/dbcsr_test_methods.F b/src/dbcsr/dbcsr_test_methods.F index 19ab7807c8..028fce447a 100644 --- a/src/dbcsr/dbcsr_test_methods.F +++ b/src/dbcsr/dbcsr_test_methods.F @@ -95,7 +95,7 @@ CONTAINS !> \brief ... !> \param z ... !> \param data_type ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** FUNCTION compx_to_dbcsr_scalar(z, data_type) RESULT(res) COMPLEX(real_8) :: z @@ -639,7 +639,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param a ... -!> \retval atoi ... +!> \return ... ! ************************************************************************************************** FUNCTION atoi(a) CHARACTER(len=*), INTENT(in) :: a @@ -651,7 +651,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param a ... -!> \retval atol ... +!> \return ... ! ************************************************************************************************** FUNCTION atol(a) CHARACTER(len=*), INTENT(in) :: a @@ -663,7 +663,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param a ... -!> \retval ator ... +!> \return ... ! ************************************************************************************************** FUNCTION ator(a) CHARACTER(len=*), INTENT(in) :: a diff --git a/src/dbcsr/dist/dbcsr_dist_methods.F b/src/dbcsr/dist/dbcsr_dist_methods.F index c208ff8239..6340ca5c4d 100644 --- a/src/dbcsr/dist/dbcsr_dist_methods.F +++ b/src/dbcsr/dist/dbcsr_dist_methods.F @@ -194,7 +194,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param dist ... -!> \retval mp_env ... +!> \return ... ! ************************************************************************************************** FUNCTION dbcsr_distribution_mp(dist) RESULT(mp_env) TYPE(dbcsr_distribution_obj), INTENT(IN) :: dist @@ -207,7 +207,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param dist ... -!> \retval nrows ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION dbcsr_distribution_nrows(dist) RESULT(nrows) TYPE(dbcsr_distribution_obj), INTENT(IN) :: dist @@ -218,7 +218,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param dist ... -!> \retval ncols ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION dbcsr_distribution_ncols(dist) RESULT(ncols) TYPE(dbcsr_distribution_obj), INTENT(IN) :: dist @@ -229,7 +229,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param dist ... -!> \retval row_dist ... +!> \return ... ! ************************************************************************************************** FUNCTION dbcsr_distribution_row_dist(dist) RESULT(row_dist) TYPE(dbcsr_distribution_obj), INTENT(IN) :: dist @@ -243,7 +243,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param dist ... -!> \retval col_dist ... +!> \return ... ! ************************************************************************************************** FUNCTION dbcsr_distribution_col_dist(dist) RESULT(col_dist) TYPE(dbcsr_distribution_obj), INTENT(IN) :: dist @@ -257,7 +257,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param dist ... -!> \retval max_row_dist ... +!> \return ... ! ************************************************************************************************** FUNCTION dbcsr_distribution_max_row_dist(dist) RESULT(max_row_dist) TYPE(dbcsr_distribution_obj), INTENT(IN) :: dist @@ -271,7 +271,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param dist ... -!> \retval max_col_dist ... +!> \return ... ! ************************************************************************************************** FUNCTION dbcsr_distribution_max_col_dist(dist) RESULT(max_col_dist) TYPE(dbcsr_distribution_obj), INTENT(IN) :: dist @@ -285,7 +285,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param dist ... -!> \retval nlocalrows ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION dbcsr_distribution_nlocal_rows(dist) RESULT(nlocalrows) TYPE(dbcsr_distribution_obj), INTENT(IN) :: dist @@ -296,7 +296,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param dist ... -!> \retval nlocalcols ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION dbcsr_distribution_nlocal_cols(dist) RESULT(nlocalcols) TYPE(dbcsr_distribution_obj), INTENT(IN) :: dist @@ -307,7 +307,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param dist ... -!> \retval local_rows ... +!> \return ... ! ************************************************************************************************** FUNCTION dbcsr_distribution_local_rows(dist) RESULT(local_rows) TYPE(dbcsr_distribution_obj), INTENT(IN) :: dist @@ -318,7 +318,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param dist ... -!> \retval local_rows ... +!> \return ... ! ************************************************************************************************** FUNCTION dbcsr_distribution_local_rows_obj(dist) RESULT(local_rows) TYPE(dbcsr_distribution_obj), INTENT(IN) :: dist @@ -329,7 +329,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param dist ... -!> \retval local_cols ... +!> \return ... ! ************************************************************************************************** FUNCTION dbcsr_distribution_local_cols(dist) RESULT(local_cols) TYPE(dbcsr_distribution_obj), INTENT(IN) :: dist @@ -340,7 +340,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param dist ... -!> \retval local_cols ... +!> \return ... ! ************************************************************************************************** FUNCTION dbcsr_distribution_local_cols_obj(dist) RESULT(local_cols) TYPE(dbcsr_distribution_obj), INTENT(IN) :: dist @@ -354,7 +354,7 @@ CONTAINS !> \param dist ... !> \param row ... !> \param col ... -!> \retval processor ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION dbcsr_distribution_processor(dist, row, col) & RESULT(processor) @@ -381,7 +381,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param dist ... -!> \retval thread_dist ... +!> \return ... ! ************************************************************************************************** FUNCTION dbcsr_distribution_thread_dist(dist) RESULT(thread_dist) TYPE(dbcsr_distribution_obj), INTENT(IN) :: dist @@ -395,7 +395,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param dist ... -!> \retval has_thread_dist ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION dbcsr_distribution_has_threads(dist) RESULT(has_thread_dist) TYPE(dbcsr_distribution_obj), INTENT(IN) :: dist @@ -409,7 +409,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param dist ... -!> \retval num_threads ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION dbcsr_distribution_num_threads(dist) RESULT(num_threads) TYPE(dbcsr_distribution_obj), INTENT(IN) :: dist @@ -426,7 +426,7 @@ CONTAINS !> \param nblocks ... !> \param[in] nprows Number of row processors !> \param[in] npcols Number of column processors -!> \retval num_images Number of images +!> \return Number of images ! ************************************************************************************************** FUNCTION dbcsr_distribution_get_num_images_1d(matrix_dense_size_1d, nblocks, & nprows, npcols) RESULT(num_images_1d) diff --git a/src/dbcsr/dist/dbcsr_dist_operations.F b/src/dbcsr/dist/dbcsr_dist_operations.F index 1dfeebc1df..284221f287 100644 --- a/src/dbcsr/dist/dbcsr_dist_operations.F +++ b/src/dbcsr/dist/dbcsr_dist_operations.F @@ -72,7 +72,7 @@ CONTAINS !> \brief Determines whether a transpose must be applied !> \param[in] row The absolute matrix row. !> \param[in] column The absolute matrix column. -!> \retval transpose ... +!> \return ... ! ************************************************************************************************** ELEMENTAL FUNCTION checker_tr(row, column) RESULT(transpose) INTEGER, INTENT(IN) :: row, column @@ -89,7 +89,7 @@ CONTAINS !> \param[in] pgrid process grid !> \param[in] row_dist row distribution !> \param[in] col_dist column distribution -!> \retval process home process of the given element +!> \return home process of the given element !> \note This routine is a more low-level version of !> dbcsr_get_stored_coordinate without the setting the row and column !> to the stored position. @@ -722,7 +722,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Determines whether most blocks are stored transposed in normally. !> \param[in] blk_p Pointers to blocks -!> \retval mostly_non_transposed ... +!> \return ... !> \note Tries to be quick and not necessarily accurate. ! ************************************************************************************************** PURE FUNCTION mostly_non_transposed(blk_p) diff --git a/src/dbcsr/dist/dbcsr_min_heap.F b/src/dbcsr/dist/dbcsr_min_heap.F index 92b04cbbaa..3591700bef 100644 --- a/src/dbcsr/dist/dbcsr_min_heap.F +++ b/src/dbcsr/dist/dbcsr_min_heap.F @@ -41,7 +41,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param n ... -!> \retval parent ... +!> \return ... ! ************************************************************************************************** ELEMENTAL FUNCTION get_parent(n) RESULT(parent) INTEGER, INTENT(IN) :: n @@ -53,7 +53,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param n ... -!> \retval child ... +!> \return ... ! ************************************************************************************************** ELEMENTAL FUNCTION get_left_child(n) RESULT(child) INTEGER, INTENT(IN) :: n @@ -65,7 +65,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param n ... -!> \retval child ... +!> \return ... ! ************************************************************************************************** ELEMENTAL FUNCTION get_right_child(n) RESULT(child) INTEGER, INTENT(IN) :: n @@ -78,7 +78,7 @@ CONTAINS !> \brief ... !> \param heap ... !> \param n ... -!> \retval value ... +!> \return ... ! ************************************************************************************************** ELEMENTAL FUNCTION get_value(heap, n) RESULT(value) TYPE(dbcsr_heap_type), INTENT(IN) :: heap @@ -92,7 +92,7 @@ CONTAINS !> \brief ... !> \param heap ... !> \param key ... -!> \retval value ... +!> \return ... ! ************************************************************************************************** ELEMENTAL FUNCTION get_value_by_key(heap, key) RESULT(value) TYPE(dbcsr_heap_type), INTENT(IN) :: heap diff --git a/src/dbcsr/dist/dbcsr_mp_methods.F b/src/dbcsr/dist/dbcsr_mp_methods.F index 338fc7e1ae..f814747f80 100644 --- a/src/dbcsr/dist/dbcsr_mp_methods.F +++ b/src/dbcsr/dist/dbcsr_mp_methods.F @@ -50,7 +50,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Checks whether this process is part of the message passing environment !> \param mp_env ... -!> \retval active ... +!> \return ... ! ************************************************************************************************** FUNCTION dbcsr_mp_active(mp_env) RESULT(active) TYPE(dbcsr_mp_obj), INTENT(IN) :: mp_env @@ -185,7 +185,7 @@ CONTAINS !> \param mp_env ... !> \param prow ... !> \param pcol ... -!> \retval process ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION dbcsr_mp_get_process(mp_env, prow, pcol) RESULT(process) TYPE(dbcsr_mp_obj), INTENT(IN) :: mp_env @@ -198,7 +198,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param mp_env ... -!> \retval pgrid ... +!> \return ... ! ************************************************************************************************** FUNCTION dbcsr_mp_pgrid(mp_env) RESULT(pgrid) TYPE(dbcsr_mp_obj), INTENT(IN) :: mp_env @@ -209,7 +209,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param mp_env ... -!> \retval numnodes ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION dbcsr_mp_numnodes(mp_env) RESULT(numnodes) TYPE(dbcsr_mp_obj), INTENT(IN) :: mp_env @@ -220,7 +220,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param mp_env ... -!> \retval mynode ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION dbcsr_mp_mynode(mp_env) RESULT(mynode) TYPE(dbcsr_mp_obj), INTENT(IN) :: mp_env @@ -231,7 +231,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param mp_env ... -!> \retval mp_group ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION dbcsr_mp_group(mp_env) RESULT(mp_group) TYPE(dbcsr_mp_obj), INTENT(IN) :: mp_env @@ -242,7 +242,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param mp_env ... -!> \retval nprows ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION dbcsr_mp_nprows(mp_env) RESULT(nprows) TYPE(dbcsr_mp_obj), INTENT(IN) :: mp_env @@ -253,7 +253,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param mp_env ... -!> \retval npcols ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION dbcsr_mp_npcols(mp_env) RESULT(npcols) TYPE(dbcsr_mp_obj), INTENT(IN) :: mp_env @@ -264,7 +264,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param mp_env ... -!> \retval myprow ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION dbcsr_mp_myprow(mp_env) RESULT(myprow) TYPE(dbcsr_mp_obj), INTENT(IN) :: mp_env @@ -275,7 +275,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param mp_env ... -!> \retval mypcol ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION dbcsr_mp_mypcol(mp_env) RESULT(mypcol) TYPE(dbcsr_mp_obj), INTENT(IN) :: mp_env @@ -286,7 +286,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param mp_env ... -!> \retval has_subgroups ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION dbcsr_mp_has_subgroups(mp_env) RESULT(has_subgroups) TYPE(dbcsr_mp_obj), INTENT(IN) :: mp_env @@ -297,7 +297,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param mp_env ... -!> \retval row_group ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION dbcsr_mp_my_row_group(mp_env) RESULT(row_group) TYPE(dbcsr_mp_obj), INTENT(IN) :: mp_env @@ -308,7 +308,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param mp_env ... -!> \retval col_group ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION dbcsr_mp_my_col_group(mp_env) RESULT(col_group) TYPE(dbcsr_mp_obj), INTENT(IN) :: mp_env diff --git a/src/dbcsr/dist/dbcsr_mp_operations.F b/src/dbcsr/dist/dbcsr_mp_operations.F index 29838267d0..cee3012270 100644 --- a/src/dbcsr/dist/dbcsr_mp_operations.F +++ b/src/dbcsr/dist/dbcsr_mp_operations.F @@ -355,7 +355,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Creates an MPI combined type from the given anytype. !> \param[in] data_area Data area of any type -!> \retval mp_type Type descriptor +!> \return Type descriptor ! ************************************************************************************************** FUNCTION dbcsr_mp_type_from_anytype(data_area) RESULT(mp_type) TYPE(dbcsr_data_obj), INTENT(IN) :: data_area @@ -702,7 +702,7 @@ CONTAINS !> \param lengths ... !> \param displs ... !> \param data_type ... -!> \retval new_mp_data_type ... +!> \return ... ! ************************************************************************************************** FUNCTION dbcsr_mp_type_indexed_make_any(count, lengths, displs, data_type) & RESULT(new_mp_data_type) diff --git a/src/dbcsr/dist/dbcsr_util.F b/src/dbcsr/dist/dbcsr_util.F index 265f0c5736..c1ee9cea13 100644 --- a/src/dbcsr/dist/dbcsr_util.F +++ b/src/dbcsr/dist/dbcsr_util.F @@ -131,7 +131,7 @@ CONTAINS !> \brief The sum of a subset of rows/columns !> \param[in] all_offsets ordered offsets of all the elements !> \param[in] local_elements enumerated local elements -!> \retval nfull_elements sum of sizes of local elemetns +!> \return sum of sizes of local elemetns !> \note Used for making matrices dense/undense ! ************************************************************************************************** PURE FUNCTION nfull_elements (all_offsets, local_elements) @@ -356,7 +356,7 @@ CONTAINS !> \param n ... !> \param oldsign ... !> \param x ... -!> \retval val ... +!> \return ... ! ************************************************************************************************** ELEMENTAL FUNCTION sgn (n, oldsign, x) RESULT (val) INTEGER, INTENT(IN) :: n, oldsign @@ -493,7 +493,7 @@ CONTAINS !> \param[in] matrix matrix !> \param[in] local (optional) no global communication !> \param[in] pos (optional) position-dependent checksum -!> \retval checksum calculated checksum +!> \return calculated checksum ! ************************************************************************************************** FUNCTION dbcsr_checksum(matrix, local, pos) RESULT(checksum) TYPE(dbcsr_type), INTENT(IN) :: matrix @@ -618,7 +618,7 @@ CONTAINS !> \param tr ... !> \param ro ... !> \param co ... -!> \retval pd_cs ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION pd_blk_cs (ld, od, DATA, tr, ro, co) RESULT (pd_cs) INTEGER, INTENT(IN) :: ld, od diff --git a/src/dbcsr/mm/dbcsr_mm_3d.F b/src/dbcsr/mm/dbcsr_mm_3d.F index a271b4dbc6..66bae1faa0 100644 --- a/src/dbcsr/mm/dbcsr_mm_3d.F +++ b/src/dbcsr/mm/dbcsr_mm_3d.F @@ -1060,7 +1060,7 @@ CONTAINS !> \param mypcol ... !> \param nprows ... !> \param side3D ... -!> \retval get_rank3D ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION get_rank3D(myprow, mypcol, nprows, side3D) INTEGER, INTENT(IN) :: myprow, mypcol, nprows, side3D @@ -2908,7 +2908,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... -!> \retval get_max_layers_3D ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION get_max_layers_3D() INTEGER :: get_max_layers_3D diff --git a/src/dbcsr/mm/dbcsr_mm_common.F b/src/dbcsr/mm/dbcsr_mm_common.F index af18cdab33..333a19e4c8 100644 --- a/src/dbcsr/mm/dbcsr_mm_common.F +++ b/src/dbcsr/mm/dbcsr_mm_common.F @@ -529,7 +529,7 @@ CONTAINS !> \param left_col_nimages ... !> \param right_row_nimages ... !> \param nthreads ... -!> \retval size_guess ... +!> \return ... !> \author Alfio Lazzaro ! ************************************************************************************************** FUNCTION product_matrix_size_guess(matrix_left, matrix_right, product_matrix, & diff --git a/src/dbcsr/mm/dbcsr_mm_csr.F b/src/dbcsr/mm/dbcsr_mm_csr.F index 3a80581692..210a5360cf 100644 --- a/src/dbcsr/mm/dbcsr_mm_csr.F +++ b/src/dbcsr/mm/dbcsr_mm_csr.F @@ -971,7 +971,7 @@ CONTAINS !> \brief Determines whether a transpose must be applied !> \param[in] row The absolute matrix row. !> \param[in] column The absolute matrix column. -!> \retval transpose ... +!> \return ... !> \par Source !> This function is copied from dbcsr_dist_operations for speed reasons. ! ************************************************************************************************** diff --git a/src/dbcsr/mm/dbcsr_mm_multrec.F b/src/dbcsr/mm/dbcsr_mm_multrec.F index 7eefe15c61..39c192c25c 100644 --- a/src/dbcsr/mm/dbcsr_mm_multrec.F +++ b/src/dbcsr/mm/dbcsr_mm_multrec.F @@ -568,7 +568,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Return number of blocks !> \param this ... -!> \retval nblks ... +!> \return ... !> \author Alfio Lazzaro ! ************************************************************************************************** FUNCTION dbcsr_mm_multrec_get_nblks(this) RESULT(nblks) @@ -582,7 +582,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Return data size !> \param this ... -!> \retval nze ... +!> \return ... !> \author Alfio Lazzaro ! ************************************************************************************************** FUNCTION dbcsr_mm_multrec_get_nze(this) RESULT(nze) @@ -711,7 +711,7 @@ CONTAINS !> \param af ... !> \param a ... !> \param val ... -!> \retval res ... +!> \return ... !> \author JV ! ************************************************************************************************** PURE FUNCTION find_cut_row(ai, af, a, val) RESULT(res) @@ -761,7 +761,7 @@ CONTAINS !> \param af ... !> \param a ... !> \param val ... -!> \retval res ... +!> \return ... !> \author JV ! ************************************************************************************************** PURE FUNCTION find_cut_col(ai, af, a, val) RESULT(res) diff --git a/src/dbcsr/ops/dbcsr_csr_conversions.F b/src/dbcsr/ops/dbcsr_csr_conversions.F index e2badd5355..4ce60bfd4e 100644 --- a/src/dbcsr/ops/dbcsr_csr_conversions.F +++ b/src/dbcsr/ops/dbcsr_csr_conversions.F @@ -1009,7 +1009,7 @@ CONTAINS !> structure and same sparsity pattern !> \param[in] matrix_a ... !> \param[in] matrix_b ... -!> \retval is_equal whether matrix_a and matrix_b have the same block structure +!> \return whether matrix_a and matrix_b have the same block structure !> \par History !> 11.2014 created [Patrick Seewald] !> \author Patrick Seewald diff --git a/src/dbcsr/ops/dbcsr_operations.F b/src/dbcsr/ops/dbcsr_operations.F index da9769edfa..dce54bebe8 100644 --- a/src/dbcsr/ops/dbcsr_operations.F +++ b/src/dbcsr/ops/dbcsr_operations.F @@ -1167,7 +1167,7 @@ CONTAINS !> \brief note: does not check the symmetry of the data itself !> \param matrix_type ... !> \param data_type ... -!> \retval symmetry_consistent ... +!> \return ... ! ************************************************************************************************** LOGICAL FUNCTION symmetry_consistent(matrix_type, data_type) CHARACTER, INTENT(IN) :: matrix_type @@ -1200,7 +1200,7 @@ CONTAINS !> \brief data from matrix_a(source) to matrix_b(target) !> \param matrix_type_a ... !> \param matrix_type_b ... -!> \retval symmetry_compatible ... +!> \return ... ! ************************************************************************************************** LOGICAL FUNCTION symmetry_compatible(matrix_type_a, matrix_type_b) CHARACTER, INTENT(IN) :: matrix_type_a, matrix_type_b @@ -1527,7 +1527,7 @@ CONTAINS !> \param col1 ... !> \param row2 ... !> \param col2 ... -!> \retval relation Relation between positions 1 and 2. +!> \return Relation between positions 1 and 2. !> 0: same !> -1: pos1 < pos2 !> 1: pos1 > pos2 @@ -2253,7 +2253,7 @@ CONTAINS ! ************************************************************************************************** !> \brief compute a norm of a dbcsr matrix !> \param[in] matrix the matrix -!> \retval norm ... +!> \return ... ! ************************************************************************************************** FUNCTION dbcsr_gershgorin_norm(matrix) RESULT(norm) @@ -2347,7 +2347,7 @@ CONTAINS ! ************************************************************************************************** !> \brief compute a norm of a dbcsr matrix !> \param[in] matrix the matrix -!> \retval norm ... +!> \return ... ! ************************************************************************************************** FUNCTION dbcsr_maxabs(matrix) RESULT(norm) TYPE(dbcsr_type), INTENT(INOUT) :: matrix @@ -2393,7 +2393,7 @@ CONTAINS !> \brief compute a norm of a dbcsr matrix !> \param[in] matrix the matrix !> \param local ... -!> \retval norm ... +!> \return ... ! ************************************************************************************************** FUNCTION dbcsr_frobenius_norm(matrix, local) RESULT(norm) @@ -2580,7 +2580,7 @@ CONTAINS !> \param[in] col ... !> \param[in] block_row_limits ... !> \param[in] block_column_limits ... -!> \retval dbcsr_block_in_limits ... +!> \return ... ! ************************************************************************************************** FUNCTION dbcsr_block_in_limits(row, col, block_row_limits, block_column_limits) INTEGER, INTENT(in) :: row, col @@ -2688,7 +2688,7 @@ CONTAINS !> \brief Returns whether the matrix could be represeneted in a dense form !> \param[in] matrix matrix !> \param occ_thresh ... -!> \retval may_be_dense use the mutable and not append-only working +!> \return use the mutable and not append-only working !> structures ! ************************************************************************************************** FUNCTION dbcsr_may_be_dense(matrix, occ_thresh) RESULT(may_be_dense) @@ -2709,7 +2709,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Returns the occupation of the matrix !> \param matrix matrix from which to get the occupation -!> \retval occupation ... +!> \return ... ! ************************************************************************************************** FUNCTION dbcsr_get_occupation(matrix) RESULT(occupation) TYPE(dbcsr_type), INTENT(IN) :: matrix diff --git a/src/dbcsr_tensor/array_list_methods.F b/src/dbcsr_tensor/array_list_methods.F index 7b715d9f1b..7435c8dbe4 100644 --- a/src/dbcsr_tensor/array_list_methods.F +++ b/src/dbcsr_tensor/array_list_methods.F @@ -46,7 +46,7 @@ CONTAINS ! ************************************************************************************************** !> \brief number of arrays stored in list !> \param list ... -!> \retval number_of_arrays ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION number_of_arrays(list) TYPE(array_list), INTENT(IN) :: list @@ -60,7 +60,7 @@ CONTAINS !> \brief Get an element for each array. !> \param list ... !> \param indices element index for each array -!> \retval get_array_elements ... +!> \return ... ! ************************************************************************************************** FUNCTION get_array_elements(list, indices) TYPE(array_list), INTENT(IN) :: list @@ -184,7 +184,7 @@ CONTAINS ! ************************************************************************************************** !> \brief sizes of arrays stored in list !> \param list ... -!> \retval sizes_of_arrays ... +!> \return ... ! ************************************************************************************************** FUNCTION sizes_of_arrays(list) TYPE(array_list), INTENT(IN) :: list @@ -202,7 +202,7 @@ CONTAINS ! ************************************************************************************************** !> \brief sum of all elements for each array stored in list !> \param list ... -!> \retval sum_of_arrays ... +!> \return ... ! ************************************************************************************************** FUNCTION sum_of_arrays(list) TYPE(array_list), INTENT(IN) :: list diff --git a/src/dbcsr_tensor/dbcsr_tensor_block.F b/src/dbcsr_tensor/dbcsr_tensor_block.F index 3bdbff5ce7..77df015f75 100644 --- a/src/dbcsr_tensor/dbcsr_tensor_block.F +++ b/src/dbcsr_tensor/dbcsr_tensor_block.F @@ -184,7 +184,7 @@ CONTAINS ! ************************************************************************************************** !> \brief block size !> \param block ... -!> \retval blk_size ... +!> \return ... ! ************************************************************************************************** FUNCTION block_size(block) TYPE(block_nd), INTENT(IN) :: block @@ -245,7 +245,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Number of dimensions. !> \param iterator ... -!> \retval ndims_iterator ... +!> \return ... !> \par Note: specification function below must be defined before it is used in !> the source due to a bug in the IBM XL Fortran compiler (compilation fails) ! ************************************************************************************************** @@ -295,7 +295,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Generalization of dbcsr_iterator_blocks_left for tensors. !> \param iterator ... -!> \retval dbcsr_t_iterator_blocks_left ... +!> \return ... ! ************************************************************************************************** FUNCTION dbcsr_t_iterator_blocks_left(iterator) TYPE(dbcsr_t_iterator_type), INTENT(IN) :: iterator @@ -446,7 +446,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Number of non-zero blocks !> \param tensor ... -!> \retval nblocks_reserved ... +!> \return ... ! ************************************************************************************************** FUNCTION nblocks_reserved(tensor) TYPE(dbcsr_t_type), INTENT(IN) :: tensor diff --git a/src/dbcsr_tensor/dbcsr_tensor_index.F b/src/dbcsr_tensor/dbcsr_tensor_index.F index 1c4373dcf9..7a5ada8d6e 100644 --- a/src/dbcsr_tensor/dbcsr_tensor_index.F +++ b/src/dbcsr_tensor/dbcsr_tensor_index.F @@ -114,7 +114,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param map ... -!> \retval ndims_mapping ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION ndims_mapping(map) TYPE(nd_to_2d_mapping), INTENT(IN) :: map @@ -190,7 +190,7 @@ CONTAINS !> \param dims nd dimensions !> \param base base index, default 1 (Fortran style) !> \param col_major column major ordering, default .TRUE. (Fortran style) -!> \retval ind_out flat index +!> \return flat index ! ************************************************************************************************** FUNCTION combine_index(ind_in, dims, base, col_major) RESULT(ind_out) INTEGER, DIMENSION(:), INTENT(IN) :: ind_in, dims @@ -238,7 +238,7 @@ CONTAINS !> \param dims nd dimensions !> \param base base index, default 1 (Fortran style) !> \param col_major column major ordering, default .TRUE. (Fortran style) -!> \retval ind_out nd index +!> \return nd index ! ************************************************************************************************** FUNCTION split_index(ind_in, dims, base, col_major) RESULT(ind_out) INTEGER, INTENT(IN) :: ind_in @@ -285,7 +285,7 @@ CONTAINS !> \brief transform nd index to 2d index, using info from index mapping. !> \param map index mapping !> \param ind_in nd index -!> \retval ind_out 2d index +!> \return 2d index ! ************************************************************************************************** FUNCTION get_2d_indices(map, ind_in) RESULT(ind_out) TYPE(nd_to_2d_mapping), INTENT(IN) :: map @@ -305,7 +305,7 @@ CONTAINS !> \brief transform 2d index to nd index, using info from index mapping. !> \param map index mapping !> \param ind_in 2d index -!> \retval ind_out nd index +!> \return nd index ! ************************************************************************************************** FUNCTION get_nd_indices(map, ind_in) RESULT(ind_out) TYPE(nd_to_2d_mapping), INTENT(IN) :: map @@ -325,7 +325,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Invert order !> \param order ... -!> \retval dbcsr_t_inverse_order ... +!> \return ... ! ************************************************************************************************** FUNCTION dbcsr_t_inverse_order(order) INTEGER, DIMENSION(:), INTENT(IN) :: order diff --git a/src/dbcsr_tensor/dbcsr_tensor_reshape.F b/src/dbcsr_tensor/dbcsr_tensor_reshape.F index 1f1ba5b9bb..b8864a2cf2 100644 --- a/src/dbcsr_tensor/dbcsr_tensor_reshape.F +++ b/src/dbcsr_tensor/dbcsr_tensor_reshape.F @@ -203,7 +203,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param buffer ... -!> \retval ndims_buffer ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION ndims_buffer(buffer) TYPE(block_buffer_type), INTENT(IN) :: buffer @@ -285,7 +285,7 @@ CONTAINS ! ************************************************************************************************** !> \brief how many blocks left in iterator !> \param buffer ... -!> \retval block_buffer_blocks_left ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION block_buffer_blocks_left(buffer) TYPE(block_buffer_type), INTENT(IN) :: buffer diff --git a/src/dbcsr_tensor/dbcsr_tensor_test.F b/src/dbcsr_tensor/dbcsr_tensor_test.F index 7d740b43c1..d876afe4fb 100644 --- a/src/dbcsr_tensor/dbcsr_tensor_test.F +++ b/src/dbcsr_tensor/dbcsr_tensor_test.F @@ -80,7 +80,7 @@ CONTAINS !> \brief check if two (arbitrarily mapped and distributed) tensors are equal. !> \param tensor1 ... !> \param tensor2 ... -!> \retval dbcsr_t_equal ... +!> \return ... ! ************************************************************************************************** FUNCTION dbcsr_t_equal(tensor1, tensor2) TYPE(dbcsr_t_type), INTENT(INOUT) :: tensor1, tensor2 @@ -119,7 +119,7 @@ CONTAINS !> \brief check if two blocks are equal !> \param block1 ... !> \param block2 ... -!> \retval blocks_equal ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION blocks_equal(block1, block2) TYPE(block_nd), INTENT(IN) :: block1, block2 @@ -137,7 +137,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Compute factorial !> \param n ... -!> \retval factorial ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION factorial(n) INTEGER, INTENT(IN) :: n diff --git a/src/dbcsr_tensor/dbcsr_tensor_types.F b/src/dbcsr_tensor/dbcsr_tensor_types.F index 281a1caa48..dcb47c9fe9 100644 --- a/src/dbcsr_tensor/dbcsr_tensor_types.F +++ b/src/dbcsr_tensor/dbcsr_tensor_types.F @@ -94,7 +94,7 @@ CONTAINS !> \param map1_2d which nd-indices map to first matrix index and in which order !> \param map2_2d which nd-indices map to second matrix index and in which order !> \param dims_nd nd dimensions -!> \retval communicator with nd cartesian grid +!> \return with nd cartesian grid ! ************************************************************************************************** FUNCTION dbcsr_t_nd_mp_comm(comm_2d, map1_2d, map2_2d, dims_nd) INTEGER, INTENT(IN) :: comm_2d @@ -451,7 +451,7 @@ CONTAINS ! ************************************************************************************************** !> \brief tensor rank !> \param tensor ... -!> \retval ndims_tensor ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION ndims_tensor(tensor) TYPE(dbcsr_t_type), INTENT(IN) :: tensor @@ -477,7 +477,7 @@ CONTAINS ! ************************************************************************************************** !> \brief tensor data type !> \param tensor ... -!> \retval dbcsr_t_get_data_type ... +!> \return ... ! ************************************************************************************************** FUNCTION dbcsr_t_get_data_type(tensor) RESULT(data_type) TYPE(dbcsr_t_type), INTENT(IN) :: tensor diff --git a/src/dbcsrx/hash_table.f90 b/src/dbcsrx/hash_table.f90 index 348d579579..8e13df3a67 100644 --- a/src/dbcsrx/hash_table.f90 +++ b/src/dbcsrx/hash_table.f90 @@ -9,7 +9,7 @@ ! ***************************************************************************** !> \brief finds a prime equal or larger than i, needed at creation !> \param i ... -!> \retval res ... +!> \return ... ! ***************************************************************************** FUNCTION matching_prime(i) RESULT(res) INTEGER, INTENT(IN) :: i @@ -122,7 +122,7 @@ !> \brief ... !> \param hash_table ... !> \param c ... -!> \retval p ... +!> \return ... ! ***************************************************************************** PURE FUNCTION hash_table_get(hash_table,c) RESULT(p) TYPE(hash_table_type), INTENT(IN) :: hash_table diff --git a/src/dm_ls_scf_methods.F b/src/dm_ls_scf_methods.F index 7c36158e9c..176c0bd37c 100644 --- a/src/dm_ls_scf_methods.F +++ b/src/dm_ls_scf_methods.F @@ -1137,7 +1137,7 @@ CONTAINS !> \param x ... !> \param gamma_values ... !> \param i ... -!> \retval xr ... +!> \return ... ! ************************************************************************************************** FUNCTION evaluate_trs4_polynomial(x, gamma_values, i) RESULT(xr) REAL(KIND=dp) :: x @@ -1166,7 +1166,7 @@ CONTAINS !> \param homo ... !> \param lumo ... !> \param threshold ... -!> \retval steps ... +!> \return ... ! ************************************************************************************************** FUNCTION estimate_steps(homo, lumo, threshold) RESULT(steps) REAL(KIND=dp) :: homo, lumo, threshold diff --git a/src/domain_submatrix_methods.F b/src/domain_submatrix_methods.F index 035d4f3e92..7887c1f66f 100644 --- a/src/domain_submatrix_methods.F +++ b/src/domain_submatrix_methods.F @@ -1639,7 +1639,7 @@ CONTAINS !> \param map ... !> \param row ... !> \param col ... -!> \retval qblk_exists ... +!> \return ... !> \par History !> 2013.01 created [Rustam Z. Khaliullin] !> \author Rustam Z. Khaliullin diff --git a/src/eri_mme/eri_mme_gaussian.F b/src/eri_mme/eri_mme_gaussian.F index b0d63158cf..46714ce9ef 100644 --- a/src/eri_mme/eri_mme_gaussian.F +++ b/src/eri_mme/eri_mme_gaussian.F @@ -64,7 +64,7 @@ CONTAINS !> \brief Norm of 1d Hermite-Gauss functions !> \param zet ... !> \param l ... -!> \retval norm ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION hermite_gauss_norm(zet, l) RESULT(norm) REAL(KIND=dp), INTENT(IN) :: zet diff --git a/src/eri_mme/eri_mme_lattice_summation.F b/src/eri_mme/eri_mme_lattice_summation.F index 900fa07412..3f508845f6 100644 --- a/src/eri_mme/eri_mme_lattice_summation.F +++ b/src/eri_mme/eri_mme_lattice_summation.F @@ -352,7 +352,7 @@ CONTAINS !> \param ns_G ... !> \param l ... !> \param m ... -!> \retval nsum_2c_gspace_1d ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION nsum_2c_gspace_1d(ns_G, l, m) REAL(KIND=dp), INTENT(IN) :: ns_G @@ -410,7 +410,7 @@ CONTAINS !> \param ns_G ... !> \param l ... !> \param m ... -!> \retval nsum_2c_gspace_3d ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION nsum_2c_gspace_3d(ns_G, l, m) REAL(KIND=dp), INTENT(IN) :: ns_G @@ -507,7 +507,7 @@ CONTAINS !> \param ns_R ... !> \param l ... !> \param m ... -!> \retval nsum_2c_rspace_1d ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION nsum_2c_rspace_1d(ns_R, l, m) REAL(KIND=dp), INTENT(IN) :: ns_R @@ -568,7 +568,7 @@ CONTAINS !> \param ns_R ... !> \param l ... !> \param m ... -!> \retval nsum_2c_rspace_3d ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION nsum_2c_rspace_3d(ns_R, l, m) REAL(KIND=dp), INTENT(IN) :: ns_R @@ -837,7 +837,7 @@ CONTAINS !> \param l ... !> \param m ... !> \param n ... -!> \retval nsum_3c_gspace_1d ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION nsum_3c_gspace_1d(ns_G1, ns_G2, l, m, n) REAL(KIND=dp), INTENT(IN) :: ns_G1, ns_G2 @@ -1001,7 +1001,7 @@ CONTAINS !> \param l ... !> \param m ... !> \param n ... -!> \retval nsum_product_3c_gspace_1d ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION nsum_product_3c_gspace_1d(ns_G, ns_R, l, m, n) REAL(KIND=dp), INTENT(IN) :: ns_G, ns_R @@ -1134,7 +1134,7 @@ CONTAINS !> \param l ... !> \param m ... !> \param n ... -!> \retval nsum_3c_rspace_1d ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION nsum_3c_rspace_1d(ns_R1, ns_R2, l, m, n) REAL(KIND=dp), INTENT(IN) :: ns_R1, ns_R2 @@ -1362,7 +1362,7 @@ CONTAINS !> \param l ... !> \param m ... !> \param n ... -!> \retval nsum_3c_gspace_3d ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION nsum_3c_gspace_3d(ns_G1, ns_G2, l, m, n) REAL(KIND=dp), INTENT(IN) :: ns_G1, ns_G2 @@ -1634,7 +1634,7 @@ CONTAINS !> \param l ... !> \param m ... !> \param n ... -!> \retval nsum_product_3c_gspace_3d ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION nsum_product_3c_gspace_3d(ns_G, ns_R, l, m, n) REAL(KIND=dp), INTENT(IN) :: ns_G, ns_R @@ -1854,7 +1854,7 @@ CONTAINS !> \param l ... !> \param m ... !> \param n ... -!> \retval nsum_3c_rspace_3d ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION nsum_3c_rspace_3d(ns_R1, ns_R2, l, m, n) REAL(KIND=dp), INTENT(IN) :: ns_R1, ns_R2 @@ -2033,7 +2033,7 @@ CONTAINS !> sphere for sums over non-orthogonal lattice vectors. !> \param s_rad sphere radius !> \param s_to_e sphere to ellipsoid trafo -!> \retval ellipsoid_bounds ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION ellipsoid_bounds(s_rad, s_to_e) REAL(KIND=dp), INTENT(IN) :: s_rad @@ -2053,7 +2053,7 @@ CONTAINS !> \param l ... !> \param m ... !> \param H_or_C_product ... -!> \retval nsum_gaussian_overlap ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION nsum_gaussian_overlap(l, m, H_or_C_product) INTEGER, INTENT(IN) :: l, m, H_or_C_product @@ -2092,7 +2092,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param i ... -!> \retval i_pow ... +!> \return ... ! ************************************************************************************************** PURE ELEMENTAL FUNCTION i_pow(i) INTEGER, INTENT(IN) :: i diff --git a/src/eri_mme/eri_mme_util.F b/src/eri_mme/eri_mme_util.F index b68c0b0f1a..c4917fd549 100644 --- a/src/eri_mme/eri_mme_util.F +++ b/src/eri_mme/eri_mme_util.F @@ -26,7 +26,7 @@ CONTAINS !> \brief Find minimum length of R vectors, for a general (not necessarily !> orthorhombic) cell. !> \param hmat ... -!> \retval R_m ... +!> \return ... ! ************************************************************************************************** FUNCTION R_abs_min(hmat) RESULT(R_m) REAL(KIND=dp), DIMENSION(3, 3), INTENT(IN) :: hmat @@ -59,7 +59,7 @@ CONTAINS !> \brief Find minimum length of G vectors, for a general (not necessarily !> orthorhombic) cell. !> \param h_inv ... -!> \retval G_m ... +!> \return ... ! ************************************************************************************************** FUNCTION G_abs_min(h_inv) RESULT(G_m) REAL(KIND=dp), DIMENSION(3, 3), INTENT(IN) :: h_inv diff --git a/src/et_coupling_proj.F b/src/et_coupling_proj.F index bf277ee7dc..fc4135186b 100644 --- a/src/et_coupling_proj.F +++ b/src/et_coupling_proj.F @@ -829,7 +829,7 @@ CONTAINS !> \param mo array of MO sets !> \param id state index !> \param atom list of atoms for MO coefficient summing -!> \retval c2 ... +!> \return ... !> \author Z. Futera (02.2017) ! ************************************************************************************************** FUNCTION get_mo_c2_sum(blk_at, mo, id, atom) RESULT(c2) diff --git a/src/ewald_environment_types.F b/src/ewald_environment_types.F index e8dfe921f3..94a04093e8 100644 --- a/src/ewald_environment_types.F +++ b/src/ewald_environment_types.F @@ -438,7 +438,7 @@ CONTAINS !> \brief triggers (by bisection) the optimal value for EWALD parameter x !> EXP(-x^2)/x^2 = EWALD_ACCURACY !> \param precs ... -!> \retval value ... +!> \return ... !> \author Teodoro Laino [tlaino] - University of Zurich - 12.2007 ! ************************************************************************************************** FUNCTION find_ewald_optimal_value(precs) RESULT(value) diff --git a/src/f77_interface.F b/src/f77_interface.F index 41966b4fd6..0622323b2f 100644 --- a/src/f77_interface.F +++ b/src/f77_interface.F @@ -171,7 +171,7 @@ CONTAINS ! ************************************************************************************************** !> \brief returns the position of the force env corresponding to the given id !> \param env_id the id of the requested environment -!> \retval res ... +!> \return ... !> \author fawzi !> \note !> private utility function diff --git a/src/fm/cp_cfm_basic_linalg.F b/src/fm/cp_cfm_basic_linalg.F index b884034a8a..84c218077b 100644 --- a/src/fm/cp_cfm_basic_linalg.F +++ b/src/fm/cp_cfm_basic_linalg.F @@ -1240,7 +1240,7 @@ CONTAINS !> '1' or 'O' one norm, i.e. maximum column sum, !> 'I' infinity norm, i.e. maximum row sum, !> 'F' or 'E' Frobenius norm, i.e. sqrt of sum of all squares of elements -!> \retval res the norm according to mode +!> \return the norm according to mode !> \author Lianheng Tong ! ************************************************************************************************** FUNCTION cp_cfm_norm(matrix, mode) RESULT(res) diff --git a/src/fm/cp_fm_basic_linalg.F b/src/fm/cp_fm_basic_linalg.F index d90dcc05d7..30169b9ef8 100644 --- a/src/fm/cp_fm_basic_linalg.F +++ b/src/fm/cp_fm_basic_linalg.F @@ -1868,7 +1868,7 @@ CONTAINS !> '1' or 'O' one norm, i.e. maximum column sum !> 'I' infinity norm, i.e. maximum row sum !> 'F' or 'E' Frobenius norm, i.e. sqrt of sum of all squares of elements -!> \retval res : the norm according to mode +!> \return : the norm according to mode !> \author Lianheng Tong ! ************************************************************************************************** FUNCTION cp_fm_norm(matrix, mode) RESULT(res) @@ -1959,7 +1959,7 @@ CONTAINS ! ************************************************************************************************** !> \brief trace of a matrix using pdlatra !> \param matrix : input a square matrix -!> \retval res : the trace +!> \return : the trace !> \author Lianheng Tong ! ************************************************************************************************** FUNCTION cp_fm_latra(matrix) RESULT(res) diff --git a/src/fm/cp_fm_diag_utils.F b/src/fm/cp_fm_diag_utils.F index 9f913ff24d..7ee64a0b93 100644 --- a/src/fm/cp_fm_diag_utils.F +++ b/src/fm/cp_fm_diag_utils.F @@ -138,7 +138,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Calculates the optimal number of CPUs for diagonalizing a matrix. !> \param size the size of the diagonalized matrix -!> \retval ncpu the optimal number of CPUs +!> \return the optimal number of CPUs !> \author Nico Holmberg [01.2018] ! ************************************************************************************************** FUNCTION cp_fm_diag_get_optimal_ncpu(size) RESULT(ncpu) @@ -156,7 +156,7 @@ CONTAINS !> \brief Determines the largest number of CPUs a matrix can be distributed on when the matrix is !> diagonalized with the ELPA library. !> \param matrix the matrix that will be diagonalized -!> \retval ncpu the maximum number of CPUs for ELPA +!> \return the maximum number of CPUs for ELPA !> \author Nico Holmberg [01.2018] ! ************************************************************************************************** FUNCTION cp_fm_elpa_get_max_ncpu(matrix) RESULT(ncpu) diff --git a/src/fm/cp_fm_elpa.F b/src/fm/cp_fm_elpa.F index 249859cb31..ce8182da37 100644 --- a/src/fm/cp_fm_elpa.F +++ b/src/fm/cp_fm_elpa.F @@ -82,7 +82,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Return the number of available ELPA kernels -!> \retval num ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION get_elpa_number_kernels() RESULT(num) INTEGER :: num @@ -92,7 +92,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Returns the names of the availabel ELPA kernels -!> \retval names ... +!> \return ... ! ************************************************************************************************** FUNCTION get_elpa_kernel_names() RESULT(names) CHARACTER(len=default_string_length), DIMENSION(19) :: names @@ -121,7 +121,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Returns the description texts of the availabel ELPA kernels -!> \retval descriptions ... +!> \return ... ! ************************************************************************************************** FUNCTION get_elpa_kernel_descriptions() RESULT(descriptions) CHARACTER(len=default_string_length), DIMENSION(19) :: descriptions diff --git a/src/fm/cp_fm_pool_types.F b/src/fm/cp_fm_pool_types.F index 3853a857ce..e5b675da7a 100644 --- a/src/fm/cp_fm_pool_types.F +++ b/src/fm/cp_fm_pool_types.F @@ -246,7 +246,7 @@ CONTAINS ! ************************************************************************************************** !> \brief returns the structure of the elements in this pool !> \param pool the pool you are interested in -!> \retval res ... +!> \return ... !> \par History !> 05.2002 created [fawzi] !> \author Fawzi Mohamed diff --git a/src/fm/cp_fm_struct.F b/src/fm/cp_fm_struct.F index 35cb57c90a..2b02f7ac7d 100644 --- a/src/fm/cp_fm_struct.F +++ b/src/fm/cp_fm_struct.F @@ -353,7 +353,7 @@ CONTAINS !> otherwise. !> \param fmstruct1 one of the full matrix structures to compare !> \param fmstruct2 the second of the full matrix structures to compare -!> \retval res ... +!> \return ... !> \par History !> 08.2002 created [fawzi] !> \author Fawzi Mohamed @@ -581,7 +581,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** FUNCTION cp_fm_struct_get_nrow_block() RESULT(res) INTEGER :: res @@ -591,7 +591,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** FUNCTION cp_fm_struct_get_ncol_block() RESULT(res) INTEGER :: res diff --git a/src/fm/cp_fm_types.F b/src/fm/cp_fm_types.F index f2bf1bb721..acfbac0c18 100644 --- a/src/fm/cp_fm_types.F +++ b/src/fm/cp_fm_types.F @@ -2354,7 +2354,7 @@ CONTAINS !> \param IPROC ... !> \param ISRCPROC ... !> \param NPROCS ... -!> \retval G2P ... +!> \return ... !> \author Mauro Del Ben [MDB] - 12.2012 ! ************************************************************************************************** FUNCTION cp_fm_indxg2p(INDXGLOB, NB, IPROC, ISRCPROC, NPROCS) RESULT(G2P) @@ -2416,7 +2416,7 @@ CONTAINS !> \param IPROC ... !> \param ISRCPROC ... !> \param NPROCS ... -!> \retval G2L ... +!> \return ... !> \author Mauro Del Ben [MDB] - 12.2012 ! ************************************************************************************************** FUNCTION cp_fm_indxg2l(INDXGLOB, NB, IPROC, ISRCPROC, NPROCS) RESULT(G2L) @@ -2479,7 +2479,7 @@ CONTAINS !> \param IPROC ... !> \param ISRCPROC ... !> \param NPROCS ... -!> \retval L2G ... +!> \return ... !> \author Mauro Del Ben [MDB] - 12.2012 ! ************************************************************************************************** FUNCTION cp_fm_indxl2g(INDXLOC, NB, IPROC, ISRCPROC, NPROCS) RESULT(L2G) @@ -2521,7 +2521,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** FUNCTION cp_fm_get_mm_type() RESULT(res) INTEGER :: res diff --git a/src/force_env_types.F b/src/force_env_types.F index ddbd409168..312a921876 100644 --- a/src/force_env_types.F +++ b/src/force_env_types.F @@ -453,7 +453,7 @@ CONTAINS ! ************************************************************************************************** !> \brief returns the number of atoms !> \param force_env the force_env you what information about -!> \retval n_atom the number of atoms +!> \return the number of atoms !> \date 22.11.2010 updated (MK) !> \author fawzi ! ************************************************************************************************** @@ -477,7 +477,7 @@ CONTAINS ! ************************************************************************************************** !> \brief returns the number of particles in a force environment !> \param force_env the force_env you what information about -!> \retval n_particle the number of particles +!> \return the number of particles !> \date 22.11.2010 (MK) !> \author Matthias Krack ! ************************************************************************************************** diff --git a/src/gaussian_gridlevels.F b/src/gaussian_gridlevels.F index 55721b2c00..199da59a73 100644 --- a/src/gaussian_gridlevels.F +++ b/src/gaussian_gridlevels.F @@ -136,7 +136,7 @@ CONTAINS !> \brief ... !> \param gridlevel_info ... !> \param exponent ... -!> \retval gridlevel ... +!> \return ... ! ************************************************************************************************** FUNCTION gaussian_gridlevel(gridlevel_info, exponent) RESULT(gridlevel) TYPE(gridlevel_info_type), INTENT(INOUT) :: gridlevel_info diff --git a/src/graphcon.F b/src/graphcon.F index 2a63ca3ff0..a959798f4f 100644 --- a/src/graphcon.F +++ b/src/graphcon.F @@ -361,7 +361,7 @@ CONTAINS !> \param order ... !> \param super ... !> \param classes ... -!> \retval res ... +!> \return ... !> \par History !> 09.2006 created [Joost VandeVondele] ! ************************************************************************************************** @@ -401,7 +401,7 @@ loop: DO iclass=1,super%Nele !> \param reference ... !> \param unordered ... !> \param order ... -!> \retval res ... +!> \return ... !> \par History !> 09.2006 created [Joost VandeVondele] ! ************************************************************************************************** @@ -433,7 +433,7 @@ loop: DO I=1,SIZE(reference) !> of its bonded neighbors !> \param me ... !> \param bonds ... -!> \retval res ... +!> \return ... !> \par History !> 09.2006 created [Joost VandeVondele] !> \note @@ -462,7 +462,7 @@ loop: DO I=1,SIZE(reference) ! ************************************************************************************************** !> \brief generates the hash of an array of integers and the index in the table !> \param key an integer array of any length -!> \retval hash_index ... +!> \return ... !> \par History !> 09.2006 created [Joost VandeVondele] !> \note diff --git a/src/hfx_communication.F b/src/hfx_communication.F index 71d3c3bf53..926faa1552 100644 --- a/src/hfx_communication.F +++ b/src/hfx_communication.F @@ -393,7 +393,7 @@ CONTAINS !> \param i 2d index !> \param j 2d index !> \param N matrix size -!> \retval get_1D_idx ... +!> \return ... !> \par History !> 03.2009 created [Manuel Guidon] !> \author Manuel Guidon diff --git a/src/hfx_derivatives.F b/src/hfx_derivatives.F index 64e8bc2bca..899ac761ac 100644 --- a/src/hfx_derivatives.F +++ b/src/hfx_derivatives.F @@ -1981,7 +1981,7 @@ CONTAINS !> \param i 2d index !> \param j 2d index !> \param N matrix size -!> \retval get_1D_idx ... +!> \return ... !> \par History !> 03.2009 created [Manuel Guidon] !> \author Manuel Guidon diff --git a/src/hfx_energy_potential.F b/src/hfx_energy_potential.F index 479fb7c5eb..a2196386e1 100644 --- a/src/hfx_energy_potential.F +++ b/src/hfx_energy_potential.F @@ -2380,7 +2380,7 @@ CONTAINS !> \param i 2d index !> \param j 2d index !> \param N matrix size -!> \retval get_1D_idx ... +!> \return ... !> \par History !> 03.2009 created [Manuel Guidon] !> \author Manuel Guidon diff --git a/src/hfx_helpers.F b/src/hfx_helpers.F index 037193cad8..7769eae265 100644 --- a/src/hfx_helpers.F +++ b/src/hfx_helpers.F @@ -27,7 +27,7 @@ CONTAINS !> \brief - Auxiliary function for creating periodic neighbor cells !> \param shell number of shells in each coordinate direction !> \param perd ... -!> \retval count_cells_perd ... +!> \return ... !> \par History !> 09.2007 created [Manuel Guidon] !> \author Manuel Guidon diff --git a/src/hfx_load_balance_methods.F b/src/hfx_load_balance_methods.F index a2d5272485..eb3b85da28 100644 --- a/src/hfx_load_balance_methods.F +++ b/src/hfx_load_balance_methods.F @@ -1765,7 +1765,7 @@ CONTAINS !> \param p1 ... !> \param p2 ... !> \param p3 ... -!> \retval res ... +!> \return ... !> \par History !> 08.2009 created Joost VandeVondele !> \author Joost VandeVondele @@ -1791,7 +1791,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param p ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** REAL(KIND=dp) FUNCTION estimate_basic(p) RESULT(res) REAL(KIND=dp) :: p(12) @@ -1812,7 +1812,7 @@ CONTAINS !> \param a0 ... !> \param a1 ... !> \param a2 ... -!> \retval poly2 ... +!> \return ... ! ************************************************************************************************** REAL(KIND=dp) FUNCTION poly2(x, a0, a1, a2) INTEGER :: x @@ -1902,7 +1902,7 @@ CONTAINS !> \param i 2d index !> \param j 2d index !> \param N matrix size -!> \retval get_1D_idx ... +!> \return ... !> \par History !> 03.2009 created [Manuel Guidon] !> \author Manuel Guidon @@ -1954,7 +1954,7 @@ CONTAINS !> \param coeffs_kind_max0 ... !> \param use_virial ... !> \param atomic_pair_list ... -!> \retval estimate_block_cost ... +!> \return ... ! ************************************************************************************************** FUNCTION estimate_block_cost(natom, nkind, list_ij, list_kl, set_list_ij, set_list_kl, & iatom_start, iatom_end, jatom_start, jatom_end, & diff --git a/src/hfx_screening_methods.F b/src/hfx_screening_methods.F index b36134c90c..e2f6d5a3d8 100644 --- a/src/hfx_screening_methods.F +++ b/src/hfx_screening_methods.F @@ -881,7 +881,7 @@ CONTAINS !> \param i 2d index !> \param j 2d index !> \param N matrix size -!> \retval get_1D_idx ... +!> \return ... !> \par History !> 03.2009 created [Manuel Guidon] !> \author Manuel Guidon diff --git a/src/hfx_types.F b/src/hfx_types.F index 5e5ce2e6d4..3f9367ab95 100644 --- a/src/hfx_types.F +++ b/src/hfx_types.F @@ -1682,7 +1682,7 @@ CONTAINS !> \param C ... !> \param D ... !> \param P ... -!> \retval point_is_in_quadrilateral ... +!> \return ... ! ************************************************************************************************** FUNCTION point_is_in_quadrilateral(A, B, C, D, P) REAL(dp) :: A(3), B(3), C(3), D(3), P(3) diff --git a/src/input/cp_output_handling.F b/src/input/cp_output_handling.F index 41cf32fd1d..54feb643e4 100644 --- a/src/input/cp_output_handling.F +++ b/src/input/cp_output_handling.F @@ -331,7 +331,7 @@ CONTAINS !> \param used_print_key here the print_key that was used is returned !> \param first_time if it ist the first time that an output is written !> (not fully correct, but most of the time) -!> \retval res ... +!> \return ... !> \author fawzi !> \note !> not all the propreties support can be stored @@ -426,7 +426,7 @@ CONTAINS !> does not look if this iteration it should be printed !> \param iteration_info information about the actual iteration level !> \param print_key the section values of the key to be printed -!> \retval res ... +!> \return ... !> \author fawzi ! ************************************************************************************************** FUNCTION cp_printkey_is_on(iteration_info, print_key) RESULT(res) @@ -458,7 +458,7 @@ CONTAINS !> \param print_key the section values of the key to be printed !> \param first_time returns if it is the first time that output is written !> (not fully correct, but most of the time) -!> \retval res ... +!> \return ... !> \author fawzi ! ************************************************************************************************** FUNCTION cp_printkey_is_iter(iteration_info, print_key, first_time) & @@ -520,7 +520,7 @@ CONTAINS !> (and should consequently ignore some iteration levels depending !> on COMMON_ITERATION_LEVELS). !> Defaults to false. -!> \retval res ... +!> \return ... !> \author fawzi !> \note !> If the root level is 1 removes it @@ -718,7 +718,7 @@ CONTAINS !> \param extension extension to be applied to the filename (including the ".") !> \param my_local if the unit should be local to this task, or global to the !> program (defaults to false). -!> \retval filename ... +!> \return ... !> \author Fawzi Mohamed ! ************************************************************************************************** FUNCTION cp_print_key_generate_filename(logger, print_key, middle_name, extension, & @@ -815,7 +815,7 @@ CONTAINS !> \param fout Name of the actual file where the output will be written. Needed mainly for MPI IO !> because inquiring the filename from the MPI filehandle does not work across !> all MPI libraries. -!> \retval res ... +!> \return ... ! ************************************************************************************************** FUNCTION cp_print_key_unit_nr(logger, basis_section, print_key_path, extension, & middle_name, local, log_filename, ignore_should_output, file_form, file_position, & diff --git a/src/input/cp_parser_inpp_methods.F b/src/input/cp_parser_inpp_methods.F index 952da1894e..990d9af607 100644 --- a/src/input/cp_parser_inpp_methods.F +++ b/src/input/cp_parser_inpp_methods.F @@ -600,7 +600,7 @@ CONTAINS !> \brief return index position of a variable in dictionary. 0 if not found. !> \param inpp ... !> \param varname ... -!> \retval idx ... +!> \return ... !> \par History !> - standalone proof-of-concept implemenation (22.02.2008,AK) !> - integrated into cp2k (23.02.2008) diff --git a/src/input/cp_parser_methods.F b/src/input/cp_parser_methods.F index 28b504f513..ea8c950a61 100644 --- a/src/input/cp_parser_methods.F +++ b/src/input/cp_parser_methods.F @@ -61,7 +61,7 @@ CONTAINS ! ************************************************************************************************** !> \brief return a description of the part of the file acually parsed !> \param parser the parser -!> \retval res ... +!> \return ... !> \author fawzi ! ************************************************************************************************** FUNCTION parser_location(parser) RESULT(res) @@ -385,7 +385,7 @@ CONTAINS !> \brief returns .true. if the line is a comment line or an empty line !> \param parser ... !> \param line ... -!> \retval resval ... +!> \return ... !> \par History !> 03.2009 [tlaino] - Teodoro Laino ! ************************************************************************************************** @@ -416,7 +416,7 @@ CONTAINS !> \brief returns .true. if the character passed is a comment character !> \param parser ... !> \param testchar ... -!> \retval resval ... +!> \return ... !> \par History !> 02.2008 created, AK !> \author AK @@ -702,7 +702,7 @@ CONTAINS !> - test_result : "STR": String !> \param parser ... !> \param string_length ... -!> \retval test_result ... +!> \return ... !> \date 23.11.1999 !> \author Matthias Krack (MK) !> \note - 08.2008 [tlaino] - Teodoro Laino UZH : updated for buffer @@ -879,7 +879,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Check, if the string object contains an object of type integer. !> \param string ... -!> \retval contains_integer_object ... +!> \return ... !> \date 22.11.1999 !> \author Matthias Krack (MK) !> \version 1.0 @@ -928,7 +928,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param string ... -!> \retval check ... +!> \return ... ! ************************************************************************************************** FUNCTION is_integer(string) RESULT(check) diff --git a/src/input/input_enumeration_types.F b/src/input/input_enumeration_types.F index 89315214aa..f9baed93a4 100644 --- a/src/input/input_enumeration_types.F +++ b/src/input/input_enumeration_types.F @@ -152,7 +152,7 @@ CONTAINS !> \brief maps an integer to a string !> \param enum the enumeration to use for the mapping !> \param i the value to map -!> \retval res ... +!> \return ... !> \author fawzi ! ************************************************************************************************** FUNCTION enum_i2c(enum, i) RESULT(res) @@ -194,7 +194,7 @@ CONTAINS !> \brief maps a string to an integer !> \param enum the enumeration to use for the mapping !> \param c the value to map -!> \retval res ... +!> \return ... !> \author fawzi ! ************************************************************************************************** FUNCTION enum_c2i(enum, c) RESULT(res) diff --git a/src/input/input_section_types.F b/src/input/input_section_types.F index d5f93787b7..3219f0b96e 100644 --- a/src/input/input_section_types.F +++ b/src/input/input_section_types.F @@ -266,7 +266,7 @@ CONTAINS ! ************************************************************************************************** !> \brief collects additional information on the section for IO + documentation !> \param section ... -!> \retval message ... +!> \return ... !> \author fawzi ! ************************************************************************************************** FUNCTION get_section_info(section) RESULT(message) @@ -506,7 +506,7 @@ CONTAINS !> \brief returns the index of requested subsection (-1 if not found) !> \param section the root section !> \param subsection_name the name of the subsection you want to get -!> \retval res ... +!> \return ... !> \author fawzi !> \note !> private utility function @@ -540,7 +540,7 @@ CONTAINS !> \brief returns the requested subsection !> \param section the root section !> \param subsection_name the name of the subsection you want to get -!> \retval res ... +!> \return ... !> \author fawzi ! ************************************************************************************************** FUNCTION section_get_subsection(section, subsection_name) RESULT(res) @@ -565,7 +565,7 @@ CONTAINS !> \brief returns the index of the requested keyword (or -2 if not found) !> \param section the section the keyword is in !> \param keyword_name the keyword you are interested in -!> \retval res ... +!> \return ... !> \author fawzi !> \note !> private utility function @@ -611,7 +611,7 @@ CONTAINS !> \brief returns the requested keyword !> \param section the section the keyword is in !> \param keyword_name the keyword you are interested in -!> \retval res ... +!> \return ... !> \author fawzi ! ************************************************************************************************** RECURSIVE FUNCTION section_get_keyword(section, keyword_name) RESULT(res) @@ -876,7 +876,7 @@ CONTAINS !> \param i_rep_section index of the repetition of section_vals from which !> you want to extract the subsection (defaults to 1) !> \param can_return_null if the results can be null (defaults to false) -!> \retval res ... +!> \return ... !> \author fawzi ! ************************************************************************************************** RECURSIVE FUNCTION section_vals_get_subs_vals(section_vals, subsection_name, & @@ -935,7 +935,7 @@ CONTAINS !> \param i_section index of the section !> \param i_rep_section index of the repetition of section_vals from which !> you want to extract the subsection (defaults to 1) -!> \retval res ... +!> \return ... !> \author fawzi ! ************************************************************************************************** FUNCTION section_vals_get_subs_vals2(section_vals, i_section, i_rep_section) RESULT(res) @@ -974,7 +974,7 @@ CONTAINS !> \param subsection_name ... !> \param i_rep_section index of the repetition of section_vals from which !> you want to extract the subsection (defaults to 1) -!> \retval res ... +!> \return ... !> \author fawzi ! ************************************************************************************************** FUNCTION section_vals_get_subs_vals3(section_vals, subsection_name, & @@ -1094,7 +1094,7 @@ CONTAINS !> \brief ... !> \param section_vals ... !> \param keyword_name ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** FUNCTION section_get_cval(section_vals, keyword_name) RESULT(res) @@ -1110,7 +1110,7 @@ CONTAINS !> \brief ... !> \param section_vals ... !> \param keyword_name ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** FUNCTION section_get_rval(section_vals, keyword_name) RESULT(res) @@ -1126,7 +1126,7 @@ CONTAINS !> \brief ... !> \param section_vals ... !> \param keyword_name ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** FUNCTION section_get_rvals(section_vals, keyword_name) RESULT(res) @@ -1142,7 +1142,7 @@ CONTAINS !> \brief ... !> \param section_vals ... !> \param keyword_name ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** FUNCTION section_get_ival(section_vals, keyword_name) RESULT(res) @@ -1158,7 +1158,7 @@ CONTAINS !> \brief ... !> \param section_vals ... !> \param keyword_name ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** FUNCTION section_get_ivals(section_vals, keyword_name) RESULT(res) @@ -1174,7 +1174,7 @@ CONTAINS !> \brief ... !> \param section_vals ... !> \param keyword_name ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** FUNCTION section_get_lval(section_vals, keyword_name) RESULT(res) diff --git a/src/input_cp2k_check.F b/src/input_cp2k_check.F index fca50beb47..fdc71fdfba 100644 --- a/src/input_cp2k_check.F +++ b/src/input_cp2k_check.F @@ -961,7 +961,7 @@ CONTAINS !> \param input_file the input file to initialize !> \param restart_file ... !> \param tag_section ... -!> \retval do_restart ... +!> \return ... !> \author teo ! ************************************************************************************************** FUNCTION check_restart(input_file, restart_file, tag_section) RESULT(do_restart) diff --git a/src/input_cp2k_read.F b/src/input_cp2k_read.F index 5204823299..fa1e586151 100644 --- a/src/input_cp2k_read.F +++ b/src/input_cp2k_read.F @@ -43,7 +43,7 @@ CONTAINS !> \param file_path path where the input should be read !> \param initial_variables ... !> \param para_env ... -!> \retval res ... +!> \return ... !> \author fawzi ! ************************************************************************************************** FUNCTION read_input(input_declaration, file_path, initial_variables, para_env) RESULT(res) diff --git a/src/kg_vertex_coloring_methods.F b/src/kg_vertex_coloring_methods.F index 332e2059b7..e6ac362d94 100644 --- a/src/kg_vertex_coloring_methods.F +++ b/src/kg_vertex_coloring_methods.F @@ -259,7 +259,7 @@ CONTAINS !> \brief ... !> \param dsat ... !> \param degree ... -!> \retval value ... +!> \return ... ! ************************************************************************************************** ELEMENTAL FUNCTION kg_get_value(dsat, degree) RESULT(value) INTEGER, INTENT(IN) :: dsat, degree diff --git a/src/kpoint_io.F b/src/kpoint_io.F index 0c8ff7d194..9a67a57578 100644 --- a/src/kpoint_io.F +++ b/src/kpoint_io.F @@ -150,7 +150,7 @@ CONTAINS !> \brief ... !> \param ic ... !> \param cell_to_index ... -!> \retval cell ... +!> \return ... ! ************************************************************************************************** FUNCTION get_cell(ic, cell_to_index) RESULT(cell) INTEGER, INTENT(IN) :: ic @@ -470,7 +470,7 @@ CONTAINS !> \brief ... !> \param cell ... !> \param cell_to_index ... -!> \retval index ... +!> \return ... ! ************************************************************************************************** FUNCTION get_index(cell, cell_to_index) RESULT(index) INTEGER, DIMENSION(3), INTENT(IN) :: cell diff --git a/src/kpoint_transitional.F b/src/kpoint_transitional.F index cb0ca9212b..4cfef620cf 100644 --- a/src/kpoint_transitional.F +++ b/src/kpoint_transitional.F @@ -37,7 +37,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Smart getter, raises an error when called during a k-point calculation !> \param this ... -!> \retval res ... +!> \return ... !> \author Ole Schuett ! ************************************************************************************************** FUNCTION get_1d_pointer(this) RESULT(res) @@ -55,7 +55,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Simple getter, neede because of PRIVATE !> \param this ... -!> \retval res ... +!> \return ... !> \author Ole Schuett ! ************************************************************************************************** FUNCTION get_2d_pointer(this) RESULT(res) diff --git a/src/lri_compression.F b/src/lri_compression.F index d3c9816afc..93f252fb13 100644 --- a/src/lri_compression.F +++ b/src/lri_compression.F @@ -101,7 +101,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param cont ... -!> \retval cmem ... +!> \return ... ! ************************************************************************************************** FUNCTION lri_cont_mem(cont) RESULT(cmem) TYPE(int_container), INTENT(IN) :: cont diff --git a/src/lri_environment_methods.F b/src/lri_environment_methods.F index d282c1c4b3..87f7b6e555 100644 --- a/src/lri_environment_methods.F +++ b/src/lri_environment_methods.F @@ -1055,7 +1055,7 @@ CONTAINS !> \brief ... !> \param amat ... !> \param ainv ... -!> \retval delta ... +!> \return ... ! ************************************************************************************************** FUNCTION inv_test(amat, ainv) RESULT(delta) REAL(KIND=dp), DIMENSION(:, :), INTENT(IN) :: amat, ainv diff --git a/src/manybody_siepmann.F b/src/manybody_siepmann.F index dea242fbf5..2e7727cc9a 100644 --- a/src/manybody_siepmann.F +++ b/src/manybody_siepmann.F @@ -109,7 +109,7 @@ CONTAINS !> \brief f2(r) corresponds to Equation (2) in J. Chem. Phys., Vol. 102, p.511 !> \param siepmann ... !> \param r distance between oxygen and metal atom -!> \retval siep_f2 ... +!> \return ... ! ************************************************************************************************** FUNCTION siep_f2(siepmann, r) TYPE(siepmann_pot_type), POINTER :: siepmann @@ -131,7 +131,7 @@ CONTAINS !> \brief f2(r)_d derivative of f2 !> \param siepmann ... !> \param r distance between oxygen and metal atom -!> \retval siep_f2_d ... +!> \return ... ! ************************************************************************************************** FUNCTION siep_f2_d(siepmann, r) TYPE(siepmann_pot_type), POINTER :: siepmann @@ -164,7 +164,7 @@ CONTAINS !> \param rcutsq ... !> \param particle_set ... !> \param cell ... -!> \retval siep_a_ij ... +!> \return ... !> \par History !> Using a local list of neighbors ! ************************************************************************************************** @@ -317,7 +317,7 @@ CONTAINS !> \param nr_oh ... !> \param nr_h3o ... !> \param nr_o ... -!> \retval siep_Phi_ij ... +!> \return ... !> \par History !> Using a local list of neighbors ! ************************************************************************************************** diff --git a/src/manybody_tersoff.F b/src/manybody_tersoff.F index 2d0e845b03..6109714163 100644 --- a/src/manybody_tersoff.F +++ b/src/manybody_tersoff.F @@ -76,7 +76,7 @@ CONTAINS !> \brief ... !> \param tersoff ... !> \param r ... -!> \retval ter_f_C ... +!> \return ... !> \author I-Feng W. Kuo ! ************************************************************************************************** FUNCTION ter_f_C(tersoff, r) @@ -104,7 +104,7 @@ CONTAINS !> \brief ... !> \param tersoff ... !> \param r ... -!> \retval ter_f_C_d ... +!> \return ... !> \author I-Feng W. Kuo ! ************************************************************************************************** FUNCTION ter_f_C_d(tersoff, r) @@ -133,7 +133,7 @@ CONTAINS !> \brief ... !> \param tersoff ... !> \param r ... -!> \retval ter_f_R ... +!> \return ... !> \author I-Feng W. Kuo ! ************************************************************************************************** FUNCTION ter_f_R(tersoff, r) @@ -156,7 +156,7 @@ CONTAINS !> \brief ... !> \param tersoff ... !> \param r ... -!> \retval ter_f_R_d ... +!> \return ... !> \author I-Feng W. Kuo ! ************************************************************************************************** FUNCTION ter_f_R_d(tersoff, r) @@ -180,7 +180,7 @@ CONTAINS !> \brief ... !> \param tersoff ... !> \param r ... -!> \retval ter_f_A ... +!> \return ... !> \author I-Feng W. Kuo ! ************************************************************************************************** FUNCTION ter_f_A(tersoff, r) @@ -203,7 +203,7 @@ CONTAINS !> \brief ... !> \param tersoff ... !> \param r ... -!> \retval ter_f_A_d ... +!> \return ... !> \author I-Feng W. Kuo ! ************************************************************************************************** FUNCTION ter_f_A_d(tersoff, r) @@ -225,7 +225,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param tersoff ... -!> \retval ter_a_ij ... +!> \return ... !> \author I-Feng W. Kuo ! ************************************************************************************************** FUNCTION ter_a_ij(tersoff) @@ -256,7 +256,7 @@ CONTAINS !> \param loc_cell_v ... !> \param cell_v ... !> \param rcutsq ... -!> \retval ter_b_ij ... +!> \return ... !> \author I-Feng W. Kuo, Teodoro Laino ! ************************************************************************************************** FUNCTION ter_b_ij(tersoff, r_last_update_pbc, iparticle, jparticle, n_loc_size, & @@ -294,7 +294,7 @@ CONTAINS !> \param loc_cell_v ... !> \param cell_v ... !> \param rcutsq ... -!> \retval ter_b_ij_d ... +!> \return ... !> \author I-Feng W. Kuo, Teodoro Laino ! ************************************************************************************************** FUNCTION ter_b_ij_d(tersoff, r_last_update_pbc, iparticle, jparticle, n_loc_size, & @@ -339,7 +339,7 @@ CONTAINS !> \param loc_cell_v ... !> \param cell_v ... !> \param rcutsq ... -!> \retval ter_zeta_ij ... +!> \return ... !> \par History !> Using a local list of neighbors - [tlaino] 2007 !> \author I-Feng W. Kuo, Teodoro Laino @@ -509,7 +509,7 @@ CONTAINS !> \brief ... !> \param tersoff ... !> \param costheta ... -!> \retval ter_g ... +!> \return ... !> \author I-Feng W. Kuo ! ************************************************************************************************** FUNCTION ter_g(tersoff, costheta) @@ -535,7 +535,7 @@ CONTAINS !> \brief ... !> \param tersoff ... !> \param costheta ... -!> \retval ter_g_d ... +!> \return ... !> \author I-Feng W. Kuo ! ************************************************************************************************** FUNCTION ter_g_d(tersoff, costheta) diff --git a/src/mao_methods.F b/src/mao_methods.F index c843c26fcb..e451e48204 100644 --- a/src/mao_methods.F +++ b/src/mao_methods.F @@ -382,7 +382,7 @@ CONTAINS !> \brief ... !> \param fmat1 ... !> \param fmat2 ... -!> \retval spro ... +!> \return ... ! ************************************************************************************************** FUNCTION mao_scalar_product(fmat1, fmat2) RESULT(spro) TYPE(dbcsr_type) :: fmat1, fmat2 diff --git a/src/metadyn_tools/graph_utils.F b/src/metadyn_tools/graph_utils.F index 586fb11864..0afeb8dda2 100644 --- a/src/metadyn_tools/graph_utils.F +++ b/src/metadyn_tools/graph_utils.F @@ -45,7 +45,7 @@ CONTAINS !> \param ndim ... !> \param ngrid ... !> \param dp_grid ... -!> \retval der ... +!> \return ... !> \par History !> 06.2009 created [tlaino] !> teodoro.laino .at. gmail.com @@ -85,7 +85,7 @@ CONTAINS !> \param iperd ... !> \param ngrid ... !> \param ndim ... -!> \retval pnt ... +!> \return ... !> \par History !> 03.2006 created [tlaino] !> teodoro.laino .at. gmail.com @@ -155,7 +155,7 @@ CONTAINS !> \param pos ... !> \param ngrid ... !> \param ndim ... -!> \retval pnt ... +!> \return ... !> \par History !> 03.2006 created [tlaino] !> teodoro.laino .at. gmail.com diff --git a/src/minimax/minimax_exp_k15.F b/src/minimax/minimax_exp_k15.F index c70479193e..ef87fafb67 100644 --- a/src/minimax/minimax_exp_k15.F +++ b/src/minimax/minimax_exp_k15.F @@ -91,7 +91,7 @@ CONTAINS !> \brief Sample numerical error and return its maximum. !> \param Rc ... !> \param aw ... -!> \retval numerr ... +!> \return ... !> \author Patrick Seewald ! ************************************************************************************************** FUNCTION get_minimax_numerical_error(Rc, aw) RESULT(numerr) diff --git a/src/molsym.F b/src/molsym.F index 344312f82d..a0d0da1f8f 100644 --- a/src/molsym.F +++ b/src/molsym.F @@ -560,7 +560,7 @@ CONTAINS !> \param a ... !> \param sym ... !> \param coord ... -!> \retval caxis ... +!> \return ... !> \par History !> Creation (19.10.98, Matthias Krack) !> \author jgh @@ -810,7 +810,7 @@ CONTAINS !> \param a ... !> \param sym ... !> \param coord ... -!> \retval equatom ... +!> \return ... !> \par History !> Creation (19.10.98, Matthias Krack) !> \author jgh @@ -1026,7 +1026,7 @@ CONTAINS !> \brief Return .TRUE., if the atom atoma is in the list symequ_list. !> \param atoma ... !> \param sym ... -!> \retval in_symequ_list ... +!> \return ... !> \par History !> Creation (21.04.95, Matthias Krack) !> \author jgh @@ -1258,7 +1258,7 @@ CONTAINS !> \param a ... !> \param coord ... !> \param sym ... -!> \retval naxis ... +!> \return ... !> \par History !> Creation (16.11.98, Matthias Krack) !> \author jgh @@ -1304,7 +1304,7 @@ CONTAINS !> redundant symmetry elements. !> \param se1 ... !> \param se2 ... -!> \retval newse ... +!> \return ... !> \par History !> Creation (16.11.98, Matthias Krack) !> \author jgh @@ -1332,7 +1332,7 @@ CONTAINS !> \param a ... !> \param sym ... !> \param coord ... -!> \retval nsigma ... +!> \return ... !> \par History !> Creation (16.11.98, Matthias Krack) !> \author jgh @@ -1573,7 +1573,7 @@ CONTAINS !> \param a ... !> \param sym ... !> \param coord ... -!> \retval saxis ... +!> \return ... !> \par History !> Creation (16.11.98, Matthias Krack) !> \author jgh @@ -1621,7 +1621,7 @@ CONTAINS !> \param a ... !> \param sym ... !> \param coord ... -!> \retval sigma ... +!> \return ... !> \par History !> Creation (16.11.98, Matthias Krack) !> \author jgh @@ -1740,7 +1740,7 @@ CONTAINS !> \brief Distance between two points !> \param a ... !> \param b ... -!> \retval d ... +!> \return ... !> \author jgh ! ************************************************************************************************** FUNCTION dist(a, b) RESULT(d) diff --git a/src/motion/bfgs_optimizer.F b/src/motion/bfgs_optimizer.F index 2cb827f8d1..49da01579c 100644 --- a/src/motion/bfgs_optimizer.F +++ b/src/motion/bfgs_optimizer.F @@ -1064,7 +1064,7 @@ CONTAINS !> \param j ... !> \param d ... !> \param rho ... -!> \retval deriv ... +!> \return ... ! ************************************************************************************************** FUNCTION dist_second_deriv(r1,i,j,d,rho) RESULT(deriv) REAL(KIND=dp), DIMENSION(3) :: r1 @@ -1084,7 +1084,7 @@ CONTAINS !> \param iat_der ... !> \param jat_der ... !> \param natom ... -!> \retval deriv ... +!> \return ... ! ************************************************************************************************** FUNCTION angle_second_deriv(r_ij,d_ij,rho_ij,idir,jdir,iat_der,jat_der,natom) RESULT(deriv) REAL(KIND=dp), DIMENSION(:, :, :) :: r_ij diff --git a/src/motion/cg_utils.F b/src/motion/cg_utils.F index cfe53220b2..007f209feb 100644 --- a/src/motion/cg_utils.F +++ b/src/motion/cg_utils.F @@ -728,7 +728,7 @@ CONTAINS !> \param xicom ... !> \param output_unit ... !> \param globenv ... -!> \retval dbrent ... +!> \return ... !> \par History !> 10.2005 created [tlaino] !> \author Teodoro Laino @@ -878,7 +878,7 @@ CONTAINS !> \param x ... !> \param pcom ... !> \param xicom ... -!> \retval my_val ... +!> \return ... !> \par History !> 10.2005 created [tlaino] !> \author Teodoro Laino @@ -914,7 +914,7 @@ CONTAINS !> \param pcom ... !> \param xicom ... !> \param fval ... -!> \retval my_val ... +!> \return ... !> \par History !> 10.2005 created [tlaino] !> \author Teodoro Laino @@ -951,7 +951,7 @@ CONTAINS !> \param x ... !> \param y ... !> \param dy ... -!> \retval res ... +!> \return ... !> \par History !> 10.2005 created [fawzi] !> \author Fawzi Mohamed diff --git a/src/motion/cp_lbfgs_optimizer_gopt.F b/src/motion/cp_lbfgs_optimizer_gopt.F index fb350a4296..5c1f081c06 100644 --- a/src/motion/cp_lbfgs_optimizer_gopt.F +++ b/src/motion/cp_lbfgs_optimizer_gopt.F @@ -762,7 +762,7 @@ CONTAINS !> \param geo_section ... !> \param force_env ... !> \param gopt_param ... -!> \retval res ... +!> \return ... !> \par History !> none !> \author Fawzi Mohamed diff --git a/src/motion/helium_common.F b/src/motion/helium_common.F index 24a396159b..1ae5b9bda5 100644 --- a/src/motion/helium_common.F +++ b/src/motion/helium_common.F @@ -382,7 +382,7 @@ CONTAINS ! *************************************************************************** !> \brief Decompose a permutation into cycles !> \param permutation ... -!> \retval cycles ... +!> \return ... !> \date 2013-12-11 !> \author Lukasz Walewski !> \note Given a permutation return a pointer to an array of pointers, @@ -904,7 +904,7 @@ CONTAINS !> \param rp ... !> \param tab ... !> \param cut ... -!> \retval res ... +!> \return ... !> \author Harald Forbert ! ************************************************************************************************** FUNCTION helium_eval_expansion(helium, r, rp, tab, cut) RESULT(res) @@ -1339,7 +1339,7 @@ CONTAINS !> \brief ... !> \param spl ... !> \param xx ... -!> \retval res ... +!> \return ... !> \author Harald Forbert ! ************************************************************************************************** FUNCTION helium_spline(spl, xx) RESULT(res) @@ -1371,7 +1371,7 @@ CONTAINS !> \param ib ... !> \param ja ... !> \param jb ... -!> \retval rij ... +!> \return ... !> \date 2009-07-17 !> \author Lukasz Walewski ! ************************************************************************************************** @@ -1397,7 +1397,7 @@ CONTAINS !> \param helium ... !> \param atom_number ... !> \param permutation ... -!> \retval cycle_number ... +!> \return ... !> \date 2009-07-21 !> \author Lukasz Walewski !> \note Cycles (or paths) are numbered from 1 to , where @@ -1513,7 +1513,7 @@ CONTAINS !> \param helium ... !> \param atom_number ... !> \param permutation ... -!> \retval path_length ... +!> \return ... !> \date 2009-10-07 !> \author Lukasz Walewski ! ************************************************************************************************** @@ -1550,7 +1550,7 @@ CONTAINS !> \brief Given an element of a permutation return the cycle it belongs to. !> \param element ... !> \param permutation ... -!> \retval CYCLE ... +!> \return ... !> \date 2013-12-10 !> \author Lukasz Walewski !> \note This function allocates memory and returns a pointer to it, @@ -1608,7 +1608,7 @@ CONTAINS ! *************************************************************************** !> \brief Return total winding number !> \param helium ... -!> \retval wnum ... +!> \return ... !> \date 2014-04-24 !> \author Lukasz Walewski ! ************************************************************************************************** @@ -1649,7 +1649,7 @@ CONTAINS !> \param helium ... !> \param ia ... !> \param ib ... -!> \retval wnum ... +!> \return ... !> \date 2014-04-24 !> \author Lukasz Walewski ! ************************************************************************************************** @@ -1687,7 +1687,7 @@ CONTAINS ! *************************************************************************** !> \brief Return total winding number (sum over all links) !> \param helium ... -!> \retval wnum ... +!> \return ... !> \date 2014-04-24 !> \author Lukasz Walewski !> \note mostly for sanity checks @@ -1717,7 +1717,7 @@ CONTAINS !> \param helium ... !> \param CYCLE ... !> \param pos ... -!> \retval wnum ... +!> \return ... !> \date 2014-04-24 !> \author Lukasz Walewski ! ************************************************************************************************** @@ -1769,7 +1769,7 @@ CONTAINS ! *************************************************************************** !> \brief Return total winding number (sum over all cycles) !> \param helium ... -!> \retval wnum ... +!> \return ... !> \date 2014-04-24 !> \author Lukasz Walewski !> \note mostly for sanity checks @@ -1805,7 +1805,7 @@ CONTAINS ! *************************************************************************** !> \brief Return total projected area !> \param helium ... -!> \retval area ... +!> \return ... !> \date 2014-04-24 !> \author Lukasz Walewski ! ************************************************************************************************** @@ -1862,7 +1862,7 @@ CONTAINS !> \param helium ... !> \param ia ... !> \param ib ... -!> \retval area ... +!> \return ... !> \date 2014-04-24 !> \author Lukasz Walewski ! ************************************************************************************************** @@ -1908,7 +1908,7 @@ CONTAINS ! *************************************************************************** !> \brief Return total projected area (sum over all links) !> \param helium ... -!> \retval area ... +!> \return ... !> \date 2014-04-24 !> \author Lukasz Walewski !> \note mostly for sanity checks @@ -1936,7 +1936,7 @@ CONTAINS !> \brief Return cycle projected area !> \param helium ... !> \param CYCLE ... -!> \retval area ... +!> \return ... !> \date 2014-04-24 !> \author Lukasz Walewski ! ************************************************************************************************** @@ -1991,7 +1991,7 @@ CONTAINS !> \brief Return cycle projected area (sum over all links) !> \param helium ... !> \param CYCLE ... -!> \retval area ... +!> \return ... !> \date 2014-04-24 !> \author Lukasz Walewski !> \note mostly for sanity checks @@ -2053,7 +2053,7 @@ CONTAINS ! *************************************************************************** !> \brief Return total projected area (sum over all cycles) !> \param helium ... -!> \retval area ... +!> \return ... !> \date 2014-04-24 !> \author Lukasz Walewski !> \note mostly for sanity checks @@ -2087,7 +2087,7 @@ CONTAINS ! *************************************************************************** !> \brief Return total moment of inertia divided by m_He !> \param helium ... -!> \retval moit ... +!> \return ... !> \date 2014-04-24 !> \author Lukasz Walewski ! ************************************************************************************************** @@ -2146,7 +2146,7 @@ CONTAINS !> \param helium ... !> \param ia ... !> \param ib ... -!> \retval moit ... +!> \return ... !> \date 2014-04-24 !> \author Lukasz Walewski ! ************************************************************************************************** @@ -2194,7 +2194,7 @@ CONTAINS ! *************************************************************************** !> \brief Return total moment of inertia (sum over all links) !> \param helium ... -!> \retval moit ... +!> \return ... !> \date 2014-04-24 !> \author Lukasz Walewski !> \note mostly for sanity checks @@ -2223,7 +2223,7 @@ CONTAINS !> \param helium ... !> \param CYCLE ... !> \param pos ... -!> \retval moit ... +!> \return ... !> \date 2014-04-24 !> \author Lukasz Walewski ! ************************************************************************************************** @@ -2279,7 +2279,7 @@ CONTAINS ! *************************************************************************** !> \brief Return total moment of inertia (sum over all cycles) !> \param helium ... -!> \retval moit ... +!> \return ... !> \date 2014-04-24 !> \author Lukasz Walewski !> \note mostly for sanity checks @@ -2377,7 +2377,7 @@ CONTAINS ! *************************************************************************** !> \brief Calculate center of mass !> \param helium ... -!> \retval com ... +!> \return ... !> \date 2014-04-09 !> \author Lukasz Walewski ! ************************************************************************************************** @@ -2406,7 +2406,7 @@ CONTAINS !> \param helium ... !> \param ia ... !> \param ib ... -!> \retval lvec ... +!> \return ... !> \author Lukasz Walewski ! ************************************************************************************************** FUNCTION helium_link_vector(helium, ia, ib) RESULT(lvec) @@ -2444,7 +2444,7 @@ CONTAINS !> \param helium ... !> \param ia ... !> \param ib ... -!> \retval rperp ... +!> \return ... ! ************************************************************************************************** FUNCTION helium_rperpendicular(helium, ia, ib) RESULT(rperp) @@ -2471,7 +2471,7 @@ CONTAINS !> vector units) !> \param helium ... !> \param wnum ... -!> \retval inum ... +!> \return ... !> \author Lukasz Walewski ! ************************************************************************************************** FUNCTION helium_wnumber_to_integer(helium, wnum) RESULT(inum) @@ -2500,7 +2500,7 @@ CONTAINS !> \param atmidx ... !> \param pos ... !> \param permutation ... -!> \retval is_winding ... +!> \return ... !> \date 2010-09-21 !> \author Lukasz Walewski !> \note The path winds around the periodic box if any component of its diff --git a/src/motion/helium_interactions.F b/src/motion/helium_interactions.F index d1d5d0738d..9c811f71e1 100644 --- a/src/motion/helium_interactions.F +++ b/src/motion/helium_interactions.F @@ -167,7 +167,7 @@ CONTAINS ! *************************************************************************** !> \brief Computes the total harmonic link action of the helium !> \param helium ... -!> \retval linkaction ... +!> \return ... !> \date 2016-05-03 !> \author Felix Uhl ! ************************************************************************************************** @@ -210,7 +210,7 @@ CONTAINS ! *************************************************************************** !> \brief Computes the total pair action of the helium !> \param helium ... -!> \retval pairaction ... +!> \return ... !> \date 2016-05-03 !> \author Felix Uhl ! ************************************************************************************************** @@ -257,7 +257,7 @@ CONTAINS !> \brief Computes the total interaction of the helium with the solute !> \param pint_env ... !> \param helium ... -!> \retval interaction ... +!> \return ... !> \date 2016-05-03 !> \author Felix Uhl ! ************************************************************************************************** @@ -443,7 +443,7 @@ CONTAINS !> \brief Calculate l-th Legendre polynomial P_{l}(x) at point x !> \param x ... !> \param n ... -!> \retval Pl ... +!> \return ... ! ************************************************************************************************** FUNCTION Pl(x, n) REAL(KIND=dp), INTENT(IN) :: x @@ -633,7 +633,7 @@ CONTAINS ! *************************************************************************** !> \brief Helium-helium pair interaction potential. !> \param r ... -!> \retval vij ... +!> \return ... ! ************************************************************************************************** FUNCTION helium_vij(r) RESULT(vij) @@ -662,7 +662,7 @@ CONTAINS ! *************************************************************************** !> \brief Helium-helium pair interaction potential's derivative. !> \param r ... -!> \retval dvij ... +!> \return ... ! ************************************************************************************************** FUNCTION helium_d_vij(r) RESULT(dvij) @@ -696,7 +696,7 @@ CONTAINS !> \param helium ... !> \param n ... !> \param i ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** FUNCTION helium_atom_action(helium, n, i) RESULT(res) @@ -769,7 +769,7 @@ CONTAINS !> \brief ... !> \param helium ... !> \param n ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** FUNCTION helium_link_action(helium, n) RESULT(res) @@ -826,7 +826,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param helium ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** FUNCTION helium_total_action(helium) RESULT(res) diff --git a/src/motion/helium_methods.F b/src/motion/helium_methods.F index 784e5788df..70378db9b3 100644 --- a/src/motion/helium_methods.F +++ b/src/motion/helium_methods.F @@ -2009,7 +2009,7 @@ CONTAINS !> \brief Check whether property is activated in the input structure !> \param helium ... !> \param prop ... -!> \retval is_active ... +!> \return ... !> \date 2014-06-26 !> \author Lukasz Walewski !> \note The property is controlled by two items in the input structure, diff --git a/src/motion/helium_sampling.F b/src/motion/helium_sampling.F index e0161d40b3..c000ef8017 100644 --- a/src/motion/helium_sampling.F +++ b/src/motion/helium_sampling.F @@ -748,7 +748,7 @@ CONTAINS !> \param helium ... !> \param pint_env ... !> \param cyclen ... -!> \retval res ... +!> \return ... !> \author hforbert ! ************************************************************************************************** FUNCTION helium_slice_metro_cyclic(helium, pint_env, cyclen) RESULT(res) @@ -1223,7 +1223,7 @@ CONTAINS !> \brief ... !> \param helium ... !> \param len ... -!> \retval res ... +!> \return ... !> \author hforbert ! ************************************************************************************************** FUNCTION helium_select_permutation(helium, len) RESULT(res) diff --git a/src/motion/helium_worm.F b/src/motion/helium_worm.F index fc10e2ca64..87f96a3224 100644 --- a/src/motion/helium_worm.F +++ b/src/motion/helium_worm.F @@ -1134,7 +1134,7 @@ CONTAINS !> \param ipf ... !> \param ibf ... !> \param length ... -!> \retval free_density_matrix ... +!> \return ... ! ************************************************************************************************** FUNCTION free_density_matrix(helium, ipi, ibi, ipf, ibf, length) !In the swap move, l=iabs(ibf-ibi) does not hold, @@ -1169,7 +1169,7 @@ CONTAINS !> \brief ... !> \param helium ... !> \param iatom ... -!> \retval perminv ... +!> \return ... ! ************************************************************************************************** FUNCTION perminv(helium, iatom) ! Inverse permutation function @@ -1235,7 +1235,7 @@ CONTAINS !> \param ip ... !> \param ibi ... !> \param l ... -!> \retval indroplet ... +!> \return ... ! ************************************************************************************************** FUNCTION indroplet(helium, ip, ibi, l) TYPE(helium_solvent_type), INTENT(in), POINTER :: helium @@ -1271,7 +1271,7 @@ CONTAINS !> \brief ... !> \param v1 ... !> \param v2 ... -!> \retval distance2 ... +!> \return ... ! ************************************************************************************************** FUNCTION distance2(v1, v2) REAL(KIND=dp), INTENT(in) :: v1(3), v2(3) @@ -1288,7 +1288,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param helium ... -!> \retval unit_rand_vec ... +!> \return ... ! ************************************************************************************************** FUNCTION unit_rand_vec(helium) ! Unitary random vector: diff --git a/src/motion/md_conserved_quantities.F b/src/motion/md_conserved_quantities.F index 52a0b17c63..8a1d0aa702 100644 --- a/src/motion/md_conserved_quantities.F +++ b/src/motion/md_conserved_quantities.F @@ -185,7 +185,7 @@ CONTAINS !> \brief Calculates the number of QM degress of freedom !> \param md_env ... !> \param md_ener ... -!> \retval nfree_qm ... +!> \return ... ! ************************************************************************************************** FUNCTION calc_nfree_qm(md_env, md_ener) RESULT(nfree_qm) TYPE(md_environment_type), POINTER :: md_env diff --git a/src/motion/md_environment_types.F b/src/motion/md_environment_types.F index c0ecc66464..ee8ae57b2a 100644 --- a/src/motion/md_environment_types.F +++ b/src/motion/md_environment_types.F @@ -396,7 +396,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param md_env ... -!> \retval need_per_atom_wiener_process ... +!> \return ... !> \par History !> 02.2012 created [noamb] !> \author Noam Bernstein diff --git a/src/motion/md_vel_utils.F b/src/motion/md_vel_utils.F index 7d2ed19817..9132263f3a 100644 --- a/src/motion/md_vel_utils.F +++ b/src/motion/md_vel_utils.F @@ -214,7 +214,7 @@ CONTAINS !> *** is only used by initialize_velocities below *** !> \param part ... !> \param ireg ... -!> \retval ekin ... +!> \return ... !> \par History !> 2007-11-6: created !> \author Toon Verstraelen @@ -1088,7 +1088,7 @@ CONTAINS !> to total energy !> \param dof : total number of degrees of freedom, = 3*natoms !> \param scale : scale to make sure the sum of vibrational modes give the correct energy -!> \retval res : outputs icart-th cartesian component of initial position of atom iatom +!> \return : outputs icart-th cartesian component of initial position of atom iatom !> \author Lianheng Tong, lianheng.tong@kcl.ac.uk ! ************************************************************************************************** PURE FUNCTION dr_from_vib_data(iatom, & @@ -1149,7 +1149,7 @@ CONTAINS !> to total energy !> \param dof : total number of degrees of freedom, = 3*natoms !> \param scale : scale to make sure the sum of vibrational modes give the correct energy -!> \retval res : outputs icart-th cartesian component of initial velocity of atom iatom +!> \return : outputs icart-th cartesian component of initial velocity of atom iatom !> \author Lianheng Tong, lianheng.tong@kcl.ac.uk ! ************************************************************************************************** PURE FUNCTION dv_from_vib_data(iatom, & diff --git a/src/motion/neb_io.F b/src/motion/neb_io.F index c9543ae2ea..0211bdc768 100644 --- a/src/motion/neb_io.F +++ b/src/motion/neb_io.F @@ -484,7 +484,7 @@ CONTAINS !> \param rep_env ... !> \param n_rep ... !> \param j ... -!> \retval replica_proj_name ... +!> \return ... !> \author Teodoro Laino 06.2009 ! ************************************************************************************************** FUNCTION get_replica_project_name(rep_env, n_rep, j) RESULT(replica_proj_name) diff --git a/src/motion/neb_opt_utils.F b/src/motion/neb_opt_utils.F index 9e93a43ee5..57fc7196fd 100644 --- a/src/motion/neb_opt_utils.F +++ b/src/motion/neb_opt_utils.F @@ -54,7 +54,7 @@ CONTAINS !> \param coords ... !> \param check_diis ... !> \param iw2 ... -!> \retval accepted ... +!> \return ... !> \author Teodoro Laino 10.2006 ! ************************************************************************************************** FUNCTION accept_diis_step(apply_diis, n_diis, err, crr, set_err, sline, coords, & @@ -218,7 +218,7 @@ CONTAINS !> \param ref ... !> \param output_unit ... !> \param check_diis ... -!> \retval accepted ... +!> \return ... !> \author Teodoro Laino 10.2006 ! ************************************************************************************************** FUNCTION check_diis_solution(nv, cwrk, step, ref, output_unit, check_diis) & diff --git a/src/motion/neb_utils.F b/src/motion/neb_utils.F index 162d02f085..fcdb1489fa 100644 --- a/src/motion/neb_utils.F +++ b/src/motion/neb_utils.F @@ -843,7 +843,7 @@ CONTAINS !> \param array1 ... !> \param array2 ... !> \param array3 ... -!> \retval value ... +!> \return ... !> \author Teodoro Laino 09.2006 ! ************************************************************************************************** FUNCTION dot_product_band(neb_env, array1, array2, array3) RESULT(value) @@ -1004,7 +1004,7 @@ CONTAINS !> \param neb_env ... !> \param Dcoords ... !> \param forces ... -!> \retval converged ... +!> \return ... !> \author Teodoro Laino 10.2006 ! ************************************************************************************************** FUNCTION check_convergence(neb_env, Dcoords, forces) RESULT(converged) diff --git a/src/motion/pint_methods.F b/src/motion/pint_methods.F index 79a664fd0f..92dfc85d3d 100644 --- a/src/motion/pint_methods.F +++ b/src/motion/pint_methods.F @@ -2261,7 +2261,7 @@ CONTAINS ! *************************************************************************** !> \brief calculates the total link action of the PI system (excluding helium) !> \param pint_env the path integral environment -!> \retval link_action ... +!> \return ... !> \author Felix Uhl ! ************************************************************************************************** FUNCTION pint_calc_total_link_action(pint_env) RESULT(link_action) @@ -2309,7 +2309,7 @@ CONTAINS ! *************************************************************************** !> \brief calculates the potential action of the PI system (excluding helium) !> \param pint_env the path integral environment -!> \retval pot_action ... +!> \return ... !> \author Felix Uhl ! ************************************************************************************************** FUNCTION pint_calc_total_pot_action(pint_env) RESULT(pot_action) diff --git a/src/motion/pint_public.F b/src/motion/pint_public.F index cb29e5285c..6b78e6d566 100644 --- a/src/motion/pint_public.F +++ b/src/motion/pint_public.F @@ -34,7 +34,7 @@ CONTAINS ! *************************************************************************** !> \brief Return the center of mass of the PI system !> \param pint_env ... -!> \retval com_r ... +!> \return ... !> \date 2009-07-24 !> \par History !> 2009-11-30 fixed serious bug in pint_env%x indexing [lwalewski] @@ -74,7 +74,7 @@ CONTAINS ! *************************************************************************** !> \brief Return the center of geometry of the PI system !> \param pint_env ... -!> \retval cntrd_r ... +!> \return ... !> \date 2009-11-30 !> \author Lukasz Walewski ! ************************************************************************************************** diff --git a/src/mpiwrap/message_passing.F b/src/mpiwrap/message_passing.F index d794d0b8eb..4cca11d959 100644 --- a/src/mpiwrap/message_passing.F +++ b/src/mpiwrap/message_passing.F @@ -1004,7 +1004,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** FUNCTION get_mp_perf_env() RESULT(res) TYPE(mp_perf_env_type), POINTER :: res @@ -1794,7 +1794,7 @@ CONTAINS !> \brief Tests for completion of the given requests. !> \brief We use mpi_test so that we can use a single status. !> \param requests the list of requests to test -!> \retval flag logical which determines if requests are complete +!> \return logical which determines if requests are complete !> \par History !> 3.2016 adapted to any shape [Nico Holmberg] !> \author Alfio Lazzaro @@ -3532,7 +3532,7 @@ CONTAINS !> \param subtypes ... !> \param vector_descriptor ... !> \param index_descriptor ... -!> \retval type_descriptor ... +!> \return ... ! ************************************************************************************************** FUNCTION mp_type_make_struct(subtypes, & vector_descriptor, index_descriptor) & @@ -3645,7 +3645,7 @@ CONTAINS !> \param count number of array blocks to read !> \param lengths lengths of each array block !> \param displs byte offsets for array blocks -!> \retval type_descriptor container holding the created type +!> \return container holding the created type !> \author Nico Holmberg [05.2017] ! ************************************************************************************************** FUNCTION mp_file_type_hindexed_make_chv(count, lengths, displs) & diff --git a/src/mpiwrap/message_passing.f90 b/src/mpiwrap/message_passing.f90 index 6d0708774c..293d1bddd0 100644 --- a/src/mpiwrap/message_passing.f90 +++ b/src/mpiwrap/message_passing.f90 @@ -3602,7 +3602,7 @@ !> \param count ... !> \param lengths ... !> \param displs ... -!> \retval type_descriptor ... +!> \return ... ! *************************************************************************** FUNCTION mp_type_indexed_make_${nametype1}$(count,lengths,displs) & RESULT(type_descriptor) @@ -3955,7 +3955,7 @@ !> \param ptr ... !> \param vector_descriptor ... !> \param index_descriptor ... -!> \retval type_descriptor ... +!> \return ... ! ***************************************************************************** FUNCTION mp_type_make_${nametype1}$ (ptr,& vector_descriptor, index_descriptor) & diff --git a/src/mscfg_methods.F b/src/mscfg_methods.F index 7af4cea1a8..2ae995821a 100644 --- a/src/mscfg_methods.F +++ b/src/mscfg_methods.F @@ -360,7 +360,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Is the loop over molecules requested? !> \param force_env ... -!> \retval do_mol_loop ... +!> \return ... !> \par History !> 10.2014 created [Rustam Z. Khaliullin] !> \author Rustam Z. Khaliullin diff --git a/src/negf_control_types.F b/src/negf_control_types.F index e61cccaf21..dcf3eeaf48 100644 --- a/src/negf_control_types.F +++ b/src/negf_control_types.F @@ -375,7 +375,7 @@ CONTAINS !> \param i_rep_section index of the CONTACT subsection () !> \param subsection_name name of subsection to read !> \param subsys subsystem environment -!> \retval logical that indicates whether of not the subsection has been given explicitly +!> \return that indicates whether of not the subsection has been given explicitly ! ************************************************************************************************** FUNCTION read_negf_atomlist(atomlist, negf_section, i_rep_section, subsection_name, subsys) RESULT(is_explicit) INTEGER, ALLOCATABLE, DIMENSION(:), INTENT(out) :: atomlist diff --git a/src/negf_env_types.F b/src/negf_env_types.F index 44fd5ddbef..50bf6fabd5 100644 --- a/src/negf_env_types.F +++ b/src/negf_env_types.F @@ -662,7 +662,7 @@ CONTAINS !> \param direction_vector direction vector !> \param subsys_contact QuickStep subsystem of the contact force environment !> \param eps_geometry accuracy in mapping atoms between different force environments -!> \retval direction_axis direction axis: 0 (undefined), 1 (x), 2(y), 3 (z) +!> \return direction axis: 0 (undefined), 1 (x), 2(y), 3 (z) !> \par History !> * 08.2017 created [Sergey Chulkov] ! ************************************************************************************************** diff --git a/src/negf_integr_utils.F b/src/negf_integr_utils.F index d1703e2107..fb82c04c00 100644 --- a/src/negf_integr_utils.F +++ b/src/negf_integr_utils.F @@ -118,7 +118,7 @@ CONTAINS !> \brief Compute arc radius. !> \param a lower bound !> \param b upper bound -!> \retval arc radius +!> \return radius !> \par History !> * 05.2017 created [Sergey Chulkov] !> \note Assuming Re(a) < Re(b) and Im(a) < Im(b) @@ -148,7 +148,7 @@ CONTAINS !> \brief Compute the angle phi. !> \param a lower bound !> \param b upper bound -!> \retval phi angle +!> \return angle !> \par History !> * 05.2017 created [Sergey Chulkov] !> \note Assuming Re(a) < Re(b) and Im(a) < Im(b) diff --git a/src/negf_matrix_utils.F b/src/negf_matrix_utils.F index 55be89731e..fc869a0499 100644 --- a/src/negf_matrix_utils.F +++ b/src/negf_matrix_utils.F @@ -47,7 +47,7 @@ CONTAINS !> \brief Compute the number of atomic orbitals of the given set of atoms. !> \param subsys QuickStep subsystem !> \param atom_list list of selected atom; when absent all the atoms are taken into account -!> \retval nao number of atomic orbitals +!> \return number of atomic orbitals !> \par History !> * 02.2017 created [Sergey Chulkov] ! ************************************************************************************************** @@ -779,7 +779,7 @@ CONTAINS !> Can be used with any usin cell. !> \param cell indices of the unit cell !> \param cell_to_index mapping: unit_cell -> image_index -!> \retval image DBCSR matrix images +!> \return DBCSR matrix images !> (0 means there are no non-zero matrix elements in the image) !> \par History !> * 10.2017 created [Sergey Chulkov] diff --git a/src/negf_methods.F b/src/negf_methods.F index f71f458934..857983bbe5 100644 --- a/src/negf_methods.F +++ b/src/negf_methods.F @@ -1515,7 +1515,7 @@ CONTAINS !> \brief Fermi function (exp(E/(kT)) + 1) ^ {-1} . !> \param omega 'energy' point on the complex plane !> \param temperature temperature in atomic units -!> \retval value +!> \return value !> \par History !> * 05.2017 created [Sergey Chulkov] ! ************************************************************************************************** @@ -2161,7 +2161,7 @@ CONTAINS !> \brief Generate an integration method description string. !> \param stats integration statistics !> \param integration_method integration method used -!> \retval method_descr description string +!> \return description string !> \author Sergey Chulkov ! ************************************************************************************************** PURE FUNCTION get_method_description_string(stats, integration_method) RESULT(method_descr) @@ -2196,7 +2196,7 @@ CONTAINS !> \param sub_env NEGF parallel (sub)group environment !> \param ispin spin conponent to proceed !> \param blacs_env_global global BLACS environment -!> \retval current electric current +!> \return electric current !> \author Sergey Chulkov ! ************************************************************************************************** FUNCTION negf_compute_current(contact_id1, contact_id2, negf_env, negf_control, sub_env, ispin, & diff --git a/src/negf_vectors.F b/src/negf_vectors.F index b661b68bb1..30b65055f6 100644 --- a/src/negf_vectors.F +++ b/src/negf_vectors.F @@ -107,7 +107,7 @@ CONTAINS !> \brief project the 'vector' onto the direction 'vector0'. Both vectors should have the same origin. !> \param vector vector to project !> \param vector0 direction vector -!> \retval proj projection (in terms of the direction vector's length) +!> \return projection (in terms of the direction vector's length) !> \author Sergey Chulkov !> \note \parblock !> & vector diff --git a/src/optimize_basis_utils.F b/src/optimize_basis_utils.F index 40f8890d26..a402a4c182 100644 --- a/src/optimize_basis_utils.F +++ b/src/optimize_basis_utils.F @@ -1041,7 +1041,7 @@ CONTAINS !> \param nl ... !> \param icontr ... !> \param l ... -!> \retval ientry ... +!> \return ... !> \author Florian Schiffmann ! ************************************************************************************************** diff --git a/src/optimize_embedding_potential.F b/src/optimize_embedding_potential.F index 686db44961..032be5a209 100644 --- a/src/optimize_embedding_potential.F +++ b/src/optimize_embedding_potential.F @@ -107,7 +107,7 @@ CONTAINS !> \param ref_subsys_number ... !> \param change_spin ... !> \param open_shell_embed ... -!> \retval change_spin ... +!> \return ... !> \author Vladimir Rybkin ! ************************************************************************************************** SUBROUTINE understand_spin_states(force_env, ref_subsys_number, change_spin, open_shell_embed) @@ -1828,7 +1828,7 @@ CONTAINS !> \param eigenval ... !> \param shift ... !> \param trust_rad ... -!> \retval step_minus_trad ... +!> \return ... ! ************************************************************************************************** FUNCTION shifted_step(diag_grad, eigenval, shift, trust_rad) RESULT(step_minus_trad) TYPE(cp_fm_type), POINTER :: diag_grad @@ -1865,7 +1865,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param diff_rho_r ... -!> \retval max_diff ... +!> \return ... ! ************************************************************************************************** FUNCTION max_dens_diff(diff_rho_r) RESULT(total_max_diff) TYPE(pw_p_type) :: diff_rho_r diff --git a/src/pair_potential_coulomb.F b/src/pair_potential_coulomb.F index 243030764c..e5fb3b019d 100644 --- a/src/pair_potential_coulomb.F +++ b/src/pair_potential_coulomb.F @@ -30,7 +30,7 @@ CONTAINS !> \param alpha ... !> \param beta ... !> \param interaction_cutoff ... -!> \retval potential_coulomb ... +!> \return ... !> \author Toon.Verstraelen@gmail.com ! ************************************************************************************************** FUNCTION potential_coulomb(r2, fscalar, qfac, ewald_type, alpha, beta, & diff --git a/src/pair_potential_util.F b/src/pair_potential_util.F index a0ca5454f9..2eed852ea8 100644 --- a/src/pair_potential_util.F +++ b/src/pair_potential_util.F @@ -38,7 +38,7 @@ CONTAINS !> \param pot ... !> \param r ... !> \param energy_cutoff ... -!> \retval value ... +!> \return ... ! ************************************************************************************************** FUNCTION ener_pot(pot, r, energy_cutoff) RESULT(value) TYPE(pair_potential_single_type), POINTER :: pot @@ -155,7 +155,7 @@ CONTAINS !> Only shell-model for interactions among pairs without repulsive term !> \param pot ... !> \param r ... -!> \retval ener_zbl ... +!> \return ... !> \author i soliti ignoti ! ************************************************************************************************** FUNCTION ener_zbl(pot, r) diff --git a/src/pao_input.F b/src/pao_input.F index 52c69a8202..bc0709a147 100644 --- a/src/pao_input.F +++ b/src/pao_input.F @@ -206,7 +206,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Helper routine !> \param id ... -!> \retval s ... +!> \return ... ! ************************************************************************************************** FUNCTION id2str(id) RESULT(s) INTEGER :: id diff --git a/src/pao_methods.F b/src/pao_methods.F index 2e81a977db..ed98c47a31 100644 --- a/src/pao_methods.F +++ b/src/pao_methods.F @@ -1002,7 +1002,7 @@ CONTAINS !> \param pao ... !> \param ls_scf_env ... !> \param qs_env ... -!> \retval energy ... +!> \return ... ! ************************************************************************************************** FUNCTION eval_point(block_X, i, j, eps, pao, ls_scf_env, qs_env) RESULT(energy) REAL(dp), DIMENSION(:, :), POINTER :: block_X diff --git a/src/pao_ml_gaussprocess.F b/src/pao_ml_gaussprocess.F index fb0f0b0f7e..a7cb5cdc47 100644 --- a/src/pao_ml_gaussprocess.F +++ b/src/pao_ml_gaussprocess.F @@ -166,7 +166,7 @@ CONTAINS !> \param scale ... !> \param descr1 ... !> \param descr2 ... -!> \retval cov ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION kernel(scale, descr1, descr2) RESULT(cov) REAL(dp), INTENT(IN) :: scale @@ -186,7 +186,7 @@ CONTAINS !> \param scale ... !> \param descr1 ... !> \param descr2 ... -!> \retval cov ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION kernel_grad(scale, descr1, descr2) RESULT(grad) REAL(dp), INTENT(IN) :: scale diff --git a/src/pao_param_exp.F b/src/pao_param_exp.F index 17d17ae5b8..d7f9c2982e 100644 --- a/src/pao_param_exp.F +++ b/src/pao_param_exp.F @@ -283,7 +283,7 @@ CONTAINS !> \param M ... !> \param D ... !> \param R ... -!> \retval G ... +!> \return ... ! ************************************************************************************************** FUNCTION fold_derivatives(M, D, R) RESULT(G) REAL(dp), DIMENSION(:, :), INTENT(IN) :: M diff --git a/src/pexsi_interface.F b/src/pexsi_interface.F index 1bbc7f7351..91659df432 100644 --- a/src/pexsi_interface.F +++ b/src/pexsi_interface.F @@ -266,7 +266,7 @@ CONTAINS !> \param numProcRow ... !> \param numProcCol ... !> \param outputFileIndex ... -!> \retval cp_pexsi_plan_initialize ... +!> \return ... ! ************************************************************************************************** FUNCTION cp_pexsi_plan_initialize(comm, numProcRow, numProcCol, outputFileIndex) INTEGER, INTENT(IN) :: comm, numProcRow, numProcCol, & diff --git a/src/pilaenv_hack.F b/src/pilaenv_hack.F index 6427af66e0..7782acaf0d 100644 --- a/src/pilaenv_hack.F +++ b/src/pilaenv_hack.F @@ -13,7 +13,7 @@ !> \brief ... !> \param ICTXT ... !> \param PREC ... -!> \retval PILAENV ... +!> \return ... ! ************************************************************************************************** INTEGER FUNCTION PILAENV(ICTXT, PREC) INTEGER :: ICTXT diff --git a/src/pme_tools.F b/src/pme_tools.F index c8ba483f1d..0f000e944a 100644 --- a/src/pme_tools.F +++ b/src/pme_tools.F @@ -101,7 +101,7 @@ CONTAINS !> \param pos ... !> \param lb ... !> \param ub ... -!> \retval internal ... +!> \return ... ! ************************************************************************************************** FUNCTION in_slice(pos, lb, ub) RESULT(internal) diff --git a/src/preconditioner_types.F b/src/preconditioner_types.F index 2217cf0b58..43caf79050 100644 --- a/src/preconditioner_types.F +++ b/src/preconditioner_types.F @@ -67,7 +67,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param preconditioner ... -!> \retval preconditioner_in_use ... +!> \return ... ! ************************************************************************************************** FUNCTION preconditioner_in_use(preconditioner) TYPE(preconditioner_type) :: preconditioner diff --git a/src/pw/cube_utils.F b/src/pw/cube_utils.F index 84fce11c1f..6d5c5ca197 100644 --- a/src/pw/cube_utils.F +++ b/src/pw/cube_utils.F @@ -173,7 +173,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param info ... -!> \retval return_cube_max_iradius ... +!> \return ... ! ************************************************************************************************** INTEGER FUNCTION return_cube_max_iradius(info) TYPE(cube_info_type) :: info @@ -338,7 +338,7 @@ CONTAINS !> \param dy2 ... !> \param kg2 ... !> \param jg2 ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** FUNCTION do_and_hide_it_1(prefactor, i, drmin, dz2, dy2, kg2, jg2) RESULT(res) REAL(KIND=dp) :: prefactor @@ -363,7 +363,7 @@ CONTAINS !> \param i ... !> \param jg2 ... !> \param kg2 ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** FUNCTION do_and_hide_it_2(buf, i, jg2, kg2) RESULT(res) REAL(KIND=dp), DIMENSION(:), POINTER :: buf diff --git a/src/pw/dct.F b/src/pw/dct.F index 7fb2942ffb..08df57dd0a 100644 --- a/src/pw/dct.F +++ b/src/pw/dct.F @@ -1209,7 +1209,7 @@ CONTAINS !> \brief precalculates the local bounds of a 3d array after applying flipud !> \param bndsl_in current local lower and upper bounds !> \param bounds global lower and upper bounds -!> \retval bndsl_out new local lower and upper bounds +!> \return new local lower and upper bounds !> \par History !> 07.2014 created [Hossein Bani-Hashemian] !> \author Mohammad Hossein Bani-Hashemian @@ -1245,7 +1245,7 @@ CONTAINS !> \brief precalculates the local bounds of a 3d array after applying fliplr !> \param bndsl_in current local lower and upper bounds !> \param bounds global lower and upper bounds -!> \retval bndsl_out new local lower and upper bounds +!> \return new local lower and upper bounds !> \par History !> 07.2014 created [Hossein Bani-Hashemian] !> \author Mohammad Hossein Bani-Hashemian @@ -1281,7 +1281,7 @@ CONTAINS !> \brief precalculates the local bounds of a 3d array after applying flipbf !> \param bndsl_in current local lower and upper bounds !> \param bounds global lower and upper bounds -!> \retval bndsl_out new local lower and upper bounds +!> \return new local lower and upper bounds !> \par History !> 07.2014 created [Hossein Bani-Hashemian] !> \author Mohammad Hossein Bani-Hashemian @@ -1317,7 +1317,7 @@ CONTAINS !> \brief precalculates the local bounds of a 3d array after applying rot180 !> \param bndsl_in current local lower and upper bounds !> \param bounds global lower and upper bounds -!> \retval bndsl_out new local lower and upper bounds +!> \return new local lower and upper bounds !> \par History !> 07.2014 created [Hossein Bani-Hashemian] !> \author Mohammad Hossein Bani-Hashemian diff --git a/src/pw/dgs.F b/src/pw/dgs.F index 91df55a616..6a3302c0ac 100644 --- a/src/pw/dgs.F +++ b/src/pw/dgs.F @@ -129,7 +129,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Calculate the lengths of the cell vectors a, b, and c !> \param cell_hmat ... -!> \retval abc ... +!> \return ... !> \par History 01.2014 copied from cell_types::get_cell() !> \author Ole Schuett ! ************************************************************************************************** diff --git a/src/pw/dirichlet_bc_methods.F b/src/pw/dirichlet_bc_methods.F index b4b2381820..9972d5eeb6 100644 --- a/src/pw/dirichlet_bc_methods.F +++ b/src/pw/dirichlet_bc_methods.F @@ -1080,7 +1080,7 @@ CONTAINS !> \param a starting value !> \param b end value !> \param N number of evenly-spaced points between a and b -!> \retval arr array containg N evenly-spaced points between a and b +!> \return array containg N evenly-spaced points between a and b !> \par History !> 07.2014 created [Hossein Bani-Hashemian] !> \author Mohammad Hossein Bani-Hashemian @@ -1169,7 +1169,7 @@ CONTAINS !> \param Tp image of the origin under the translation !> \param direction forward or backward transformation !> \param vec input vector -!> \retval vec_transfd transformed vector +!> \return transformed vector !> \par History !> 11.2015 created [Hossein Bani-Hashemian] !> \author Mohammad Hossein Bani-Hashemian diff --git a/src/pw/fft/fft_lib.F b/src/pw/fft/fft_lib.F index d9f30b4dfa..f52c445a72 100644 --- a/src/pw/fft/fft_lib.F +++ b/src/pw/fft/fft_lib.F @@ -33,7 +33,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Interface to FFT libraries !> \param fftlib ... -!> \retval flib ... +!> \return ... !> \par History !> IAB 09-Jan-2009 : Modified to use fft_plan_type !> (c) The Numerical Algorithms Group (NAG) Ltd, 2009 on behalf of the HECToR project diff --git a/src/pw/fft/fftw3_lib.F b/src/pw/fft/fftw3_lib.F index b6a94e06ec..7710023ce8 100644 --- a/src/pw/fft/fftw3_lib.F +++ b/src/pw/fft/fftw3_lib.F @@ -434,7 +434,7 @@ END SUBROUTINE ! ************************************************************************************************** !> \brief ... -!> \retval is_mkl ... +!> \return ... ! ************************************************************************************************** FUNCTION fftw3_is_mkl_wrapper() RESULT(is_mkl) diff --git a/src/pw/pw_grid_info.F b/src/pw/pw_grid_info.F index 3d8940fced..83c4ecca6b 100644 --- a/src/pw/pw_grid_info.F +++ b/src/pw/pw_grid_info.F @@ -39,7 +39,7 @@ CONTAINS !> \param icommensurate ... !> \param ref_grid ... !> \param n_orig ... -!> \retval n ... +!> \return ... ! ************************************************************************************************** FUNCTION pw_grid_init_setup(hmat, cutoff, spherical, odd, fft_usage, ncommensurate, & icommensurate, ref_grid, n_orig) RESULT(n) @@ -86,7 +86,7 @@ CONTAINS !> \param odd ... !> \param ncommensurate ... !> \param n_orig ... -!> \retval n ... +!> \return ... !> \author fawzi ! ************************************************************************************************** FUNCTION pw_grid_find_n(hmat, cutoff, fft_usage, spherical, odd, ncommensurate, & @@ -181,7 +181,7 @@ CONTAINS !> ffts !> \param n the minimum number of points you want !> \param odd if the number has to be odd -!> \retval nout ... +!> \return ... !> \author fawzi !> \note !> result<=n @@ -215,7 +215,7 @@ CONTAINS !> \brief Find the number of points that give at least the requested cutoff !> \param hmat ... !> \param cutoff ... -!> \retval n ... +!> \return ... !> \par History !> JGH (21-12-2000) : Simplify parameter list, bounds will be global !> JGH ( 8-01-2001) : Add check to FFT allowd grids (this now depends @@ -250,7 +250,7 @@ CONTAINS ! ************************************************************************************************** !> \brief returns the bounds that distribute n points evenly around 0 !> \param npts the number of points in each direction -!> \retval bounds ... +!> \return ... !> \author fawzi ! ************************************************************************************************** FUNCTION pw_grid_bounds_from_n(npts) RESULT(bounds) @@ -270,7 +270,7 @@ CONTAINS !> *** This routine calculates the cutoff in MOMENTUM UNITS! *** !> \param npts ... !> \param h_inv ... -!> \retval cutoff ... +!> \return ... !> \par History !> JGH (20-12-2000) : Deleted some strange comments !> \author apsi diff --git a/src/pw/pw_grids.F b/src/pw/pw_grids.F index 698f10a851..632ee51607 100644 --- a/src/pw/pw_grids.F +++ b/src/pw/pw_grids.F @@ -169,7 +169,7 @@ CONTAINS !> \brief Check if two pw_grids are equal !> \param grida ... !> \param gridb ... -!> \retval equal ... +!> \return ... !> \par History !> none !> \author JGH (14-Feb-2001) diff --git a/src/pw/pw_methods.F b/src/pw/pw_methods.F index fb25f19166..f504627a2c 100644 --- a/src/pw/pw_methods.F +++ b/src/pw/pw_methods.F @@ -1570,7 +1570,7 @@ CONTAINS !> \param use1 ... !> \param use2 ... !> \param space1 ... -!> \retval mode ... +!> \return ... ! ************************************************************************************************** FUNCTION fftselect(use1, use2, space1) RESULT(mode) INTEGER, INTENT(IN) :: use1, use2, space1 @@ -1696,7 +1696,7 @@ CONTAINS !> \brief ... !> \param grida ... !> \param gridb ... -!> \retval compat ... +!> \return ... ! ************************************************************************************************** FUNCTION pw_compatible(grida, gridb) RESULT(compat) TYPE(pw_grid_type), INTENT(IN) :: grida, gridb @@ -1720,7 +1720,7 @@ CONTAINS !> only returns the real part of it ...... !> \param pw1 ... !> \param pw2 ... -!> \retval integral_value ... +!> \return ... !> \par History !> JGH (14-Mar-2001) : Parallel sum and some tests, HALFSPACE case !> \author apsi @@ -1791,7 +1791,7 @@ CONTAINS !> \brief ... !> \param pw1 ... !> \param pw2 ... -!> \retval integral_value ... +!> \return ... ! ************************************************************************************************** FUNCTION pw_integral_a2b(pw1, pw2) RESULT(integral_value) @@ -1882,7 +1882,7 @@ CONTAINS !> \param fun ... !> \param isign ... !> \param oprt ... -!> \retval total_fun ... +!> \return ... ! ************************************************************************************************** FUNCTION pw_integrate_function(fun, isign, oprt) RESULT(total_fun) diff --git a/src/pw/pw_pool_types.F b/src/pw/pw_pool_types.F index ed57c9029c..579435c920 100644 --- a/src/pw/pw_pool_types.F +++ b/src/pw/pw_pool_types.F @@ -279,7 +279,7 @@ CONTAINS ! ************************************************************************************************** !> \brief tries to pop an element from the given list (no error on failure) !> \param list the list to pop -!> \retval res ... +!> \return ... !> \par History !> 08.2002 created [fawzi] !> \author Fawzi Mohamed diff --git a/src/pw/pw_spline_utils.F b/src/pw/pw_spline_utils.F index c44df41ad0..b2fe563bab 100644 --- a/src/pw/pw_spline_utils.F +++ b/src/pw/pw_spline_utils.F @@ -2732,7 +2732,7 @@ CONTAINS !> \param eps_r the requested precision on the residual !> \param eps_x the requested precision on the solution !> \param max_iter maximum number of iteration allowed -!> \retval res ... +!> \return ... !> \author fawzi ! ************************************************************************************************** FUNCTION find_coeffs(values, coeffs, linOp, preconditioner, pool, & @@ -3225,7 +3225,7 @@ CONTAINS !> input vector (vec) !> \param vec ... !> \param pw ... -!> \retval val ... +!> \return ... !> \par History !> 12.2007 Adapted for use with distributed grids [rdeclerck] !> \author Teodoro Laino 12/2005 [tlaino] @@ -3377,7 +3377,7 @@ CONTAINS !> function on the generic input vector (vec) !> \param vec ... !> \param pw ... -!> \retval val ... +!> \return ... !> \par History !> 12.2007 Adapted for use with distributed grids [rdeclerck] !> \author Teodoro Laino 12/2005 [tlaino] diff --git a/src/pw/realspace_grid_types.F b/src/pw/realspace_grid_types.F index f202929073..699f477483 100644 --- a/src/pw/realspace_grid_types.F +++ b/src/pw/realspace_grid_types.F @@ -170,7 +170,7 @@ CONTAINS !> \param rs_desc ... !> \param rank_in ... !> \param shift ... -!> \retval rank_out ... +!> \return ... ! ************************************************************************************************** FUNCTION rs_grid_locate_rank(rs_desc, rank_in, shift) RESULT(rank_out) TYPE(realspace_grid_desc_type), POINTER :: rs_desc @@ -2175,7 +2175,7 @@ CONTAINS !> \brief returns the maximum number of points in the local grid of any process !> to account for the case where the grid may later be reordered !> \param desc ... -!> \retval max_ngpts ... +!> \return ... !> \par History !> 10.2011 created [Iain Bethune] ! ************************************************************************************************** diff --git a/src/pw/rs_methods.F b/src/pw/rs_methods.F index 020a0f144c..6dd24e6c4c 100644 --- a/src/pw/rs_methods.F +++ b/src/pw/rs_methods.F @@ -467,7 +467,7 @@ CONTAINS ! ************************************************************************************************** !> \brief computes the norm 2 of a vector in the three-dimensional real space !> \param vec input vector -!> \retval vec_norm2 ... +!> \return ... ! ************************************************************************************************** PURE FUNCTION vec_norm2(vec) REAL(dp), DIMENSION(3), INTENT(IN) :: vec diff --git a/src/qmmm_ff_fist.F b/src/qmmm_ff_fist.F index 48a225bd1f..4d4670eb9e 100644 --- a/src/qmmm_ff_fist.F +++ b/src/qmmm_ff_fist.F @@ -28,7 +28,7 @@ CONTAINS !> \param id3 ... !> \param id4 ... !> \param is_link ... -!> \retval only_qm ... +!> \return ... !> \par History !> 11.2004 created [tlaino] !> \author Teodoro Laino @@ -104,7 +104,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param id1 ... -!> \retval is_link ... +!> \return ... ! ************************************************************************************************** FUNCTION qmmm_ff_precond_only_link(id1) RESULT(is_link) CHARACTER(LEN=default_string_length), & diff --git a/src/qmmm_util.F b/src/qmmm_util.F index 86b76d4884..63947dd51d 100644 --- a/src/qmmm_util.F +++ b/src/qmmm_util.F @@ -534,7 +534,7 @@ CONTAINS !> \param particles_mm ... !> \param mm_cell ... !> \param qm_atom_index ... -!> \retval qmmm_pbc_aware_mean ... +!> \return ... ! ************************************************************************************************** FUNCTION qmmm_pbc_aware_mean(particles_mm, mm_cell, qm_atom_index) TYPE(particle_type), DIMENSION(:), POINTER :: particles_mm @@ -560,7 +560,7 @@ CONTAINS !> \param mm_cell ... !> \param p1 ... !> \param p2 ... -!> \retval qmmm_lat_dv ... +!> \return ... ! ************************************************************************************************** FUNCTION qmmm_lat_dv(mm_cell, p1, p2) TYPE(cell_type), POINTER :: mm_cell @@ -586,7 +586,7 @@ CONTAINS !> \param i_dim ... !> \param dir ... !> \param closest_dv ... -!> \retval closest_ip ... +!> \return ... ! ************************************************************************************************** FUNCTION qmmm_find_closest(particles_mm, mm_cell, qm_atom_index, avoid, p, i_dim, dir, closest_dv) RESULT(closest_ip) TYPE(particle_type), DIMENSION(:), POINTER :: particles_mm diff --git a/src/qs_active_space_methods.F b/src/qs_active_space_methods.F index 61cefcb89e..34b5421236 100644 --- a/src/qs_active_space_methods.F +++ b/src/qs_active_space_methods.F @@ -1330,7 +1330,7 @@ CONTAINS !> \param i ... !> \param j ... !> \param n ... -!> \retval ij ... +!> \return ... !> \par History !> 04.2016 created [JGH] ! ************************************************************************************************** @@ -1377,7 +1377,7 @@ CONTAINS !> \brief calculates index range for processor in group mp_group !> \param nindex ... !> \param mp_group ... -!> \retval irange ... +!> \return ... !> \par History !> 04.2016 created [JGH] ! ************************************************************************************************** diff --git a/src/qs_basis_gradient.F b/src/qs_basis_gradient.F index dda282fd28..c6d01aed58 100644 --- a/src/qs_basis_gradient.F +++ b/src/qs_basis_gradient.F @@ -190,7 +190,7 @@ CONTAINS !> \brief ... returns the norm of the gradient vector, taking only floating !> components into account !> \param qs_env ... -!> \retval norm ... +!> \return ... ! ************************************************************************************************** FUNCTION return_basis_center_gradient_norm(qs_env) RESULT(norm) diff --git a/src/qs_collocate_density.F b/src/qs_collocate_density.F index 7892d7fea0..267db77ede 100644 --- a/src/qs_collocate_density.F +++ b/src/qs_collocate_density.F @@ -3676,7 +3676,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param point ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** FUNCTION primitive_value(point) RESULT(res) REAL(KIND=dp) :: point(3), res diff --git a/src/qs_dftb_matrices.F b/src/qs_dftb_matrices.F index 8de0fe1700..aa92cd92aa 100644 --- a/src/qs_dftb_matrices.F +++ b/src/qs_dftb_matrices.F @@ -3091,7 +3091,7 @@ CONTAINS !> \param ga ... !> \param gb ... !> \param hb_para ... -!> \retval gamma ... +!> \return ... !> \par Literature !> Elstner et al, PRB 58 (1998) 7260 !> \par History diff --git a/src/qs_dispersion_pairpot.F b/src/qs_dispersion_pairpot.F index c13de90b50..e7fbdc639e 100644 --- a/src/qs_dispersion_pairpot.F +++ b/src/qs_dispersion_pairpot.F @@ -1841,7 +1841,7 @@ CONTAINS !> \brief ... !> \param cell ... !> \param ncell ... -!> \retval hash ... +!> \return ... ! ************************************************************************************************** FUNCTION cellhash(cell, ncell) RESULT(hash) INTEGER, DIMENSION(3), INTENT(IN) :: cell, ncell diff --git a/src/qs_external_potential.F b/src/qs_external_potential.F index 25b774a4bc..315019f4c8 100644 --- a/src/qs_external_potential.F +++ b/src/qs_external_potential.F @@ -437,7 +437,7 @@ CONTAINS !> \param subgrid part of external potential on a grid !> \param origin center of grid !> \param dr step size -!> \retval value_at_r interpolated value of external potential +!> \return interpolated value of external potential ! ************************************************************************************************** FUNCTION trilinear_interpolation(r, subgrid, origin, dr) RESULT(value_at_r) REAL(KIND=dp), DIMENSION(3) :: r @@ -465,7 +465,7 @@ CONTAINS !> \param i ... !> \param lowbound ... !> \param upbound ... -!> \retval pbc_index ... +!> \return ... ! ************************************************************************************************** FUNCTION pbc_index(i, lowbound, upbound) INTEGER :: i, lowbound, upbound, pbc_index diff --git a/src/qs_fb_atomic_halo_types.F b/src/qs_fb_atomic_halo_types.F index 50922f6a4b..74a592bfc7 100644 --- a/src/qs_fb_atomic_halo_types.F +++ b/src/qs_fb_atomic_halo_types.F @@ -218,7 +218,7 @@ CONTAINS !> \brief Checks if a fb_atomic_halo object is associated with an actual !> data content or not !> \param atomic_halo the fb_atomic_halo object -!> \retval res ... +!> \return ... !> \author Lianheng Tong (LT) lianheng.tong@kcl.ac.uk ! ************************************************************************************************** FUNCTION fb_atomic_halo_has_data(atomic_halo) RESULT(res) @@ -444,7 +444,7 @@ CONTAINS !> \param atomic_halo the atomic_halo object !> \param particle_set an array of cp2k particle set objects (this !> gives atomic information) -!> \retval nelectrons estimate of electron number +!> \return estimate of electron number !> \author Lianheng Tong (LT) lianheng.tong@kcl.ac.uk ! ************************************************************************************************** FUNCTION fb_atomic_halo_nelectrons_estimate_Z(atomic_halo, particle_set) RESULT(nelectrons) @@ -483,7 +483,7 @@ CONTAINS !> \param qs_kind_set : cp2k qs_kind objects, provides information on the !> number of contracted gaussian functions each kind !> has -!> \retval cost : computation cost w.r.t. the filter matrix +!> \return : computation cost w.r.t. the filter matrix !> calculation for this atomic halo !> \author Lianheng Tong (LT) lianheng.tong@kcl.ac.uk ! ************************************************************************************************** @@ -659,7 +659,7 @@ CONTAINS !> \brief Checks if a fb_atomic_halo_list object is associated with !> an actual data content or not !> \param atomic_halos the fb_atomic_halo_list object -!> \retval res ... +!> \return ... !> \author Lianheng Tong (LT) lianheng.tong@kcl.ac.uk ! ************************************************************************************************** FUNCTION fb_atomic_halo_list_has_data(atomic_halos) RESULT(res) diff --git a/src/qs_fb_buffer_types.F b/src/qs_fb_buffer_types.F index ab7a68088b..61d2728dbf 100644 --- a/src/qs_fb_buffer_types.F +++ b/src/qs_fb_buffer_types.F @@ -224,7 +224,7 @@ CONTAINS ! ************************************************************************************************** !> \brief check if an object as associated data !> \param buffer : fb_buffer object -!> \retval res : .TRUE. if buffer has associated data +!> \return : .TRUE. if buffer has associated data !> \author Lianheng Tong (LT) lianheng.tong@kcl.ac.uk ! ************************************************************************************************** PURE FUNCTION fb_buffer_i_has_data(buffer) RESULT(res) @@ -572,7 +572,7 @@ CONTAINS ! ************************************************************************************************** !> \brief check if an object as associated data !> \param buffer : fb_buffer object -!> \retval res : .TRUE. if buffer has associated data +!> \return : .TRUE. if buffer has associated data !> \author Lianheng Tong (LT) lianheng.tong@kcl.ac.uk ! ************************************************************************************************** PURE FUNCTION fb_buffer_d_has_data(buffer) RESULT(res) diff --git a/src/qs_fb_com_tasks_types.F b/src/qs_fb_com_tasks_types.F index 5475d93940..3804a15f4c 100644 --- a/src/qs_fb_com_tasks_types.F +++ b/src/qs_fb_com_tasks_types.F @@ -310,7 +310,7 @@ CONTAINS !> \brief Checks if a fb_com_tasks object is associated with an actual !> data content or not !> \param com_tasks the fb_com_tasks object -!> \retval res ... +!> \return ... !> \author Lianheng Tong (LT) lianheng.tong@kcl.ac.uk ! ************************************************************************************************** FUNCTION fb_com_tasks_has_data(com_tasks) RESULT(res) @@ -327,7 +327,7 @@ CONTAINS !> \brief Checks if a fb_com_atom_pairs object is associated with an actual !> data content or not !> \param atom_pairs the fb_com_atom_pairs object -!> \retval res ... +!> \return ... !> \author Lianheng Tong (LT) lianheng.tong@kcl.ac.uk ! ************************************************************************************************** FUNCTION fb_com_atom_pairs_has_data(atom_pairs) RESULT(res) diff --git a/src/qs_fb_distribution_methods.F b/src/qs_fb_distribution_methods.F index 66279dcb41..ab92c6778d 100644 --- a/src/qs_fb_distribution_methods.F +++ b/src/qs_fb_distribution_methods.F @@ -346,7 +346,7 @@ CONTAINS !> move !> \param dist_to : the destination distribution !> \param threshold ... -!> \retval res : TRUE or FALSE +!> \return : TRUE or FALSE !> \author Lianheng Tong (LT) lianheng.tong@kcl.ac.uk ! ************************************************************************************************** PURE FUNCTION fb_distribution_acceptable_move(dist_from, & @@ -668,7 +668,7 @@ CONTAINS !> the list will always be ordered with respect to cost !> \param dist : the distribution in question !> \param element : element to be added -!> \retval pos : the correct position to add the new element +!> \return : the correct position to add the new element !> \author Lianheng Tong (LT) lianheng.tong@kcl.ac.uk ! ************************************************************************************************** PURE FUNCTION fb_distribution_find_slot(dist, element) RESULT(pos) diff --git a/src/qs_fb_env_types.F b/src/qs_fb_env_types.F index fdc43d33fa..4ed9bb5b20 100644 --- a/src/qs_fb_env_types.F +++ b/src/qs_fb_env_types.F @@ -175,7 +175,7 @@ CONTAINS !> \brief Checks if a fb_env object is associated with an actual !> data content or not !> \param fb_env the fb_env object -!> \retval res ... +!> \return ... !> \author Lianheng Tong (LT) lianheng.tong@kcl.ac.uk ! ************************************************************************************************** FUNCTION fb_env_has_data(fb_env) RESULT(res) diff --git a/src/qs_fb_hash_table_types.F b/src/qs_fb_hash_table_types.F index adeb4ab1ef..9066739774 100644 --- a/src/qs_fb_hash_table_types.F +++ b/src/qs_fb_hash_table_types.F @@ -206,7 +206,7 @@ CONTAINS ! ************************************************************************************************** !> \brief check if the object has data associated to it !> \param hash_table : the fb_hash_table object in question -!> \retval res : true if hash_table%obj is associated, false otherwise +!> \return : true if hash_table%obj is associated, false otherwise !> \author Lianheng Tong (LT) lianheng.tong@kcl.ac.uk ! ************************************************************************************************** PURE FUNCTION fb_hash_table_has_data(hash_table) RESULT(res) @@ -431,7 +431,7 @@ CONTAINS !> \brief Linear probing algorithm for the hash table !> \param hash_table : the fb_hash_table object !> \param key : key to locate -!> \retval islot : slot location in the table correspond to key, 0 if key +!> \return : slot location in the table correspond to key, 0 if key !> not found !> \author Lianheng Tong (LT) lianheng.tong@kcl.ac.uk ! ************************************************************************************************** @@ -466,7 +466,7 @@ CONTAINS !> \brief Hash function !> \param hash_table : the fb_hash_table object !> \param key : key to locate -!> \retval islot : slot location in the table correspond to key, 0 if key +!> \return : slot location in the table correspond to key, 0 if key !> not found !> \author Lianheng Tong (LT) lianheng.tong@kcl.ac.uk ! ************************************************************************************************** diff --git a/src/qs_fb_matrix_data_types.F b/src/qs_fb_matrix_data_types.F index 3b08b95c7d..762d6766af 100644 --- a/src/qs_fb_matrix_data_types.F +++ b/src/qs_fb_matrix_data_types.F @@ -221,7 +221,7 @@ CONTAINS ! ************************************************************************************************** !> \brief check if the object has data associated to it !> \param matrix_data : the fb_matrix_data object in question -!> \retval res : true if matrix_data%obj is associated, false otherwise +!> \return : true if matrix_data%obj is associated, false otherwise !> \author Lianheng Tong (LT) lianheng.tong@kcl.ac.uk ! ************************************************************************************************** PURE FUNCTION fb_matrix_data_has_data(matrix_data) RESULT(res) @@ -387,7 +387,7 @@ CONTAINS !> \param row : row index (assume to start counting from 1) !> \param col : col index (assume to start counting from 1) !> \param nencode : integer used for encoding -!> \retval pair_ind : the returned value +!> \return : the returned value !> \author Lianheng Tong (LT) lianheng.tong@kcl.ac.uk ! ************************************************************************************************** PURE FUNCTION fb_matrix_data_encode_pair(row, col, nencode) & diff --git a/src/qs_fb_trial_fns_types.F b/src/qs_fb_trial_fns_types.F index 071ae926a0..2bb107af57 100644 --- a/src/qs_fb_trial_fns_types.F +++ b/src/qs_fb_trial_fns_types.F @@ -141,7 +141,7 @@ CONTAINS ! ************************************************************************************************** !> \brief check if the object has data associated to it !> \param trial_fns : the fb_trial_fns object in question -!> \retval res : true if trial_fns%obj is associated, false otherwise +!> \return : true if trial_fns%obj is associated, false otherwise !> \author Lianheng Tong (LT) lianheng.tong@kcl.ac.uk ! ************************************************************************************************** FUNCTION fb_trial_fns_has_data(trial_fns) RESULT(res) diff --git a/src/qs_hash_table_functions.F b/src/qs_hash_table_functions.F index 6e560d1293..06d8baf573 100644 --- a/src/qs_hash_table_functions.F +++ b/src/qs_hash_table_functions.F @@ -24,7 +24,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Find a prime number equal or larger than ii !> \param ii : input integer -!> \retval res : the prime number +!> \return : the prime number ! ************************************************************************************************** PURE FUNCTION hash_table_matching_prime(ii) RESULT(res) INTEGER, INTENT(IN) :: ii @@ -42,7 +42,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Check if a number is a positive prime !> \param num : number to check -!> \retval res : returns TRUE if num is a positive prime, FALSE otherwise +!> \return : returns TRUE if num is a positive prime, FALSE otherwise !> \author Lianheng Tong (LT) lianheng.tong@kcl.ac.uk ! ************************************************************************************************** PURE FUNCTION is_positive_prime(num) RESULT(res) diff --git a/src/qs_integral_utils.F b/src/qs_integral_utils.F index 3ebf7bec18..e044c3b13d 100644 --- a/src/qs_integral_utils.F +++ b/src/qs_integral_utils.F @@ -44,7 +44,7 @@ CONTAINS !> \brief Return the maximum memory usage in integral calculations !> \param qs_kind_set The info for all atomic kinds !> \param basis_type_a Type of basis -!> \retval ldmem Result +!> \return Result ! ************************************************************************************************** FUNCTION get_memory_usage_a(qs_kind_set, basis_type_a) RESULT(ldmem) @@ -71,7 +71,7 @@ CONTAINS !> \param qs_kind_set The info for all atomic kinds !> \param basis_type_a Type of basis !> \param basis_type_b Type of basis -!> \retval ldmem Result +!> \return Result ! ************************************************************************************************** FUNCTION get_memory_usage_ab(qs_kind_set, basis_type_a, basis_type_b) RESULT(ldmem) @@ -96,7 +96,7 @@ CONTAINS !> \param basis_type_a Type of basis !> \param basis_type_b Type of basis !> \param basis_type_c Type of basis -!> \retval ldmem Result +!> \return Result ! ************************************************************************************************** FUNCTION get_memory_usage_abc(qs_kind_set, basis_type_a, & basis_type_b, basis_type_c) RESULT(ldmem) @@ -124,7 +124,7 @@ CONTAINS !> \param basis_type_b Type of basis !> \param basis_type_c Type of basis !> \param basis_type_d Type of basis -!> \retval ldmem Result +!> \return Result ! ************************************************************************************************** FUNCTION get_memory_usage_abcd(qs_kind_set, basis_type_a, & basis_type_b, basis_type_c, basis_type_d) RESULT(ldmem) diff --git a/src/qs_kind_types.F b/src/qs_kind_types.F index 9f4dbdefa3..fb2698b194 100644 --- a/src/qs_kind_types.F +++ b/src/qs_kind_types.F @@ -2191,7 +2191,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Tries to parse valence eletron number using "-QXXX" notation, returns -1 if not found. !> \param string ... -!> \retval n ... +!> \return ... !> \author Ole Schuett ! ************************************************************************************************** FUNCTION parse_valence_electrons(string) RESULT(n) @@ -2888,7 +2888,7 @@ CONTAINS ! ************************************************************************************************** !> \brief finds if a given qs run needs to use nlcc !> \param qs_kind_set ... -!> \retval nlcc ... +!> \return ... ! ************************************************************************************************** FUNCTION has_nlcc(qs_kind_set) RESULT(nlcc) diff --git a/src/qs_linres_op.F b/src/qs_linres_op.F index f718cdd237..c893efecf5 100644 --- a/src/qs_linres_op.F +++ b/src/qs_linres_op.F @@ -831,7 +831,7 @@ CONTAINS !> \param a ... !> \param b ... !> \param c ... -!> \retval factor ... +!> \return ... ! ************************************************************************************************** FUNCTION fac_vecp(a, b, c) RESULT(factor) @@ -852,7 +852,7 @@ CONTAINS !> \brief ... !> \param ii ... !> \param iii ... -!> \retval i ... +!> \return ... ! ************************************************************************************************** FUNCTION ind_m2(ii, iii) RESULT(i) diff --git a/src/qs_mom_methods.F b/src/qs_mom_methods.F index 8769944178..a953053bdf 100644 --- a/src/qs_mom_methods.F +++ b/src/qs_mom_methods.F @@ -60,7 +60,7 @@ CONTAINS !> (de-)occupation list supplied by user. Check that all the indices !> are positive integers and abort if it is not the case. !> \param iarr list of molecular orbital indices to be checked -!> \retval is_unique .true. if all the elements are unique or the list contains +!> \return .true. if all the elements are unique or the list contains !> exactly one 0 element (meaning no excitation) !> \par History !> 01.2016 created [Sergey Chulkov] diff --git a/src/qs_neighbor_list_types.F b/src/qs_neighbor_list_types.F index 5e8d7fdf1b..0fbe61f7ce 100644 --- a/src/qs_neighbor_list_types.F +++ b/src/qs_neighbor_list_types.F @@ -342,7 +342,7 @@ CONTAINS !> \brief ... !> \param iterator_set ... !> \param mepos ... -!> \retval istat ... +!> \return ... ! ************************************************************************************************** FUNCTION neighbor_list_iterate(iterator_set, mepos) RESULT(istat) TYPE(neighbor_list_iterator_p_type), & @@ -434,7 +434,7 @@ CONTAINS !> \brief ... !> \param iterator_set ... !> \param mepos ... -!> \retval istat ... +!> \return ... ! ************************************************************************************************** FUNCTION nl_sub_iterate(iterator_set, mepos) RESULT(istat) TYPE(neighbor_list_iterator_p_type), & @@ -867,7 +867,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Return a pointer to the first neighbor list of a neighbor list set. !> \param neighbor_list_set ... -!> \retval first_neighbor_list ... +!> \return ... !> \date 13.09.2000 !> \author MK !> \version 1.0 @@ -884,7 +884,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Return a pointer to the first neighbor node of a neighbor list. !> \param neighbor_list ... -!> \retval first_neighbor_node ... +!> \return ... !> \date 23.06.2000, !> \author MK !> \version 1.0 diff --git a/src/qs_nl_hash_table_types.F b/src/qs_nl_hash_table_types.F index 79b12c5671..e9c402bc8d 100644 --- a/src/qs_nl_hash_table_types.F +++ b/src/qs_nl_hash_table_types.F @@ -201,7 +201,7 @@ CONTAINS ! ************************************************************************************************** !> \brief check if the object has data associated to it !> \param hash_table : the nl_hash_table object in question -!> \retval res : true if hash_table%obj is associated, false otherwise +!> \return : true if hash_table%obj is associated, false otherwise ! ************************************************************************************************** PURE FUNCTION nl_hash_table_has_data(hash_table) RESULT(res) TYPE(nl_hash_table_obj), INTENT(IN) :: hash_table @@ -382,7 +382,7 @@ CONTAINS !> \brief Linear probing algorithm for the hash table !> \param hash_table : the nl_hash_table object !> \param key : key to locate -!> \retval islot : slot location in the table correspond to key, 0 if key not found +!> \return : slot location in the table correspond to key, 0 if key not found ! ************************************************************************************************** PURE FUNCTION nl_hash_table_linear_probe(hash_table, key) RESULT(islot) TYPE(nl_hash_table_obj), INTENT(IN) :: hash_table @@ -416,7 +416,7 @@ CONTAINS !> \brief Hash function !> \param hash_table : the nl_hash_table object !> \param key : key to locate -!> \retval islot : slot location in the table correspond to key, 0 if key not found +!> \return : slot location in the table correspond to key, 0 if key not found ! ************************************************************************************************** PURE FUNCTION nl_hash_table_hash_function(hash_table, key) RESULT(hash) TYPE(nl_hash_table_obj), INTENT(IN) :: hash_table diff --git a/src/qs_o3c_types.F b/src/qs_o3c_types.F index 65bc436ad1..d5c1a742b8 100644 --- a/src/qs_o3c_types.F +++ b/src/qs_o3c_types.F @@ -467,7 +467,7 @@ CONTAINS !> \brief ... !> \param o3c_iterator ... !> \param mepos ... -!> \retval istat ... +!> \return ... ! ************************************************************************************************** FUNCTION o3c_iterate(o3c_iterator, mepos) RESULT(istat) TYPE(o3c_iterator_type) :: o3c_iterator diff --git a/src/qs_ot.F b/src/qs_ot.F index 33467eaaa4..afb709a088 100644 --- a/src/qs_ot.F +++ b/src/qs_ot.F @@ -481,7 +481,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param qs_ot_env1 ... -!> \retval update ... +!> \return ... ! ************************************************************************************************** FUNCTION qs_ot_ref_update(qs_ot_env1) RESULT(update) ! @@ -1010,7 +1010,7 @@ CONTAINS !> \brief ... !> \param e1 ... !> \param e2 ... -!> \retval cint ... +!> \return ... ! ************************************************************************************************** FUNCTION cint(e1, e2) REAL(KIND=dp) :: e1, e2 @@ -1551,7 +1551,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param x ... -!> \retval qs_ot_sinc ... +!> \return ... ! ************************************************************************************************** FUNCTION qs_ot_sinc(x) @@ -1577,7 +1577,7 @@ CONTAINS !> \brief ... !> \param xa ... !> \param ya ... -!> \retval qs_ot_sincf ... +!> \return ... ! ************************************************************************************************** FUNCTION qs_ot_sincf(xa, ya) diff --git a/src/qs_ot_minimizer.F b/src/qs_ot_minimizer.F index a1155c1ab5..af2d978493 100644 --- a/src/qs_ot_minimizer.F +++ b/src/qs_ot_minimizer.F @@ -167,7 +167,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param qs_ot_env ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** FUNCTION current_point_is_fine(qs_ot_env) RESULT(res) TYPE(qs_ot_type), DIMENSION(:), POINTER :: qs_ot_env @@ -1485,7 +1485,7 @@ CONTAINS !> \param G ... !> \param S ... !> \param n ... -!> \retval sigma ... +!> \return ... ! ************************************************************************************************** FUNCTION new_sigma(G, S, n) RESULT(sigma) ! diff --git a/src/qs_outer_scf.F b/src/qs_outer_scf.F index 86e7519cc9..c60578a5a2 100644 --- a/src/qs_outer_scf.F +++ b/src/qs_outer_scf.F @@ -59,7 +59,7 @@ CONTAINS !> this value is returned by the cdft_control type !> \param scf_control the outer loop control type !> \param cdft_control the cdft loop control type -!> \retval res the number of variables +!> \return the number of variables !> \par History !> 03.2006 created [Joost VandeVondele] ! ************************************************************************************************** diff --git a/src/qs_tddfpt2_methods.F b/src/qs_tddfpt2_methods.F index fe0b31555d..9423a2c8e0 100644 --- a/src/qs_tddfpt2_methods.F +++ b/src/qs_tddfpt2_methods.F @@ -1266,7 +1266,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Compute the number of possible singly excited states (occ -> virt) !> \param gs_mos occupied and virtual molecular orbitals optimised for the ground state -!> \retval nstates_total the number of possible single excitations +!> \return the number of possible single excitations !> \par History !> * 01.2017 created [Sergey Chulkov] ! ************************************************************************************************** @@ -1506,7 +1506,7 @@ CONTAINS !> excited state wave functions !> \param work_fm_mo_occ_mo_occ work matrices with shape [nmo_occ(spin) x nmo_occ(spin)] !> to store matrix products S_0^T * S * evects (modified on exit) -!> \retval is_nonortho true if trial vectors are non-orthogonal to occupied molecular orbitals +!> \return true if trial vectors are non-orthogonal to occupied molecular orbitals !> \par History !> * 07.2016 created [Sergey Chulkov] ! ************************************************************************************************** @@ -2529,7 +2529,7 @@ CONTAINS !> \param energy_unit I/O unit to write detailed energy information !> \param tddfpt_print_section TDDFPT print input section (need to write TDDFPT restart files) !> \param work_matrices collection of work matrices (modified on exit) -!> \retval conv energy convergence achieved (in Hartree) +!> \return energy convergence achieved (in Hartree) !> \par History !> * 03.2017 code related to Davidson eigensolver has been moved here from the main subroutine !> tddfpt() [Sergey Chulkov] @@ -3232,7 +3232,7 @@ CONTAINS !> \param tddfpt_print_section TDDFPT%PRINT input section !> \param fm_pool_ao_mo_occ pools of dense matrices with shape [nao x nmo_occ(spin)] !> \param blacs_env_global BLACS parallel environment involving all the processor -!> \retval nstates_read the number of excited states found in the restart file +!> \return the number of excited states found in the restart file !> \par History !> * 08.2016 created [Sergey Chulkov] ! ************************************************************************************************** diff --git a/src/qs_tddfpt_eigensolver.F b/src/qs_tddfpt_eigensolver.F index ad2520baac..de1b9ba35a 100644 --- a/src/qs_tddfpt_eigensolver.F +++ b/src/qs_tddfpt_eigensolver.F @@ -159,7 +159,7 @@ CONTAINS !> \param p_env ... !> \param qs_env ... !> \param out_evals ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** FUNCTION iterative_solver(in_evals, & t_env, p_env, qs_env, & diff --git a/src/qs_wf_history_methods.F b/src/qs_wf_history_methods.F index 9340f659ae..fe3a5d57bd 100644 --- a/src/qs_wf_history_methods.F +++ b/src/qs_wf_history_methods.F @@ -417,7 +417,7 @@ CONTAINS ! ************************************************************************************************** !> \brief returns a string describing the interpolation method !> \param method_nr ... -!> \retval res ... +!> \return ... !> \par History !> 02.2003 created [fawzi] !> \author fawzi diff --git a/src/qs_wf_history_types.F b/src/qs_wf_history_types.F index 78ae3cc405..2cd056e5a8 100644 --- a/src/qs_wf_history_types.F +++ b/src/qs_wf_history_types.F @@ -212,7 +212,7 @@ CONTAINS !> \brief returns a snapshot, the first being the latest snapshot !> \param wf_history the plage where to get the snapshot !> \param index the index of the snapshot you want -!> \retval res ... +!> \return ... !> \par History !> 12.2002 created [fawzi] !> \author fawzi diff --git a/src/replica_types.F b/src/replica_types.F index 543c62d7d0..078924df16 100644 --- a/src/replica_types.F +++ b/src/replica_types.F @@ -285,7 +285,7 @@ CONTAINS !> \brief returns the replica environment with the given id_nr !> \param id_nr the id_nr of the requested rep_envs !> \param ierr ... -!> \retval res ... +!> \return ... !> \author fawzi ! ************************************************************************************************** FUNCTION rep_envs_get_rep_env(id_nr, ierr) RESULT(res) diff --git a/src/se_core_matrix.F b/src/se_core_matrix.F index 1f10c27da0..56221be50b 100644 --- a/src/se_core_matrix.F +++ b/src/se_core_matrix.F @@ -1259,7 +1259,7 @@ CONTAINS !> \brief ... !> \param n ... !> \param x ... -!> \retval AA ... +!> \return ... ! ************************************************************************************************** FUNCTION AA(n, x) @@ -1368,7 +1368,7 @@ CONTAINS !> \brief ... !> \param n ... !> \param y ... -!> \retval BB ... +!> \return ... ! ************************************************************************************************** FUNCTION BB(n, y) diff --git a/src/semi_empirical_int3_utils.F b/src/semi_empirical_int3_utils.F index bff5d337f7..b78e6d7b1f 100644 --- a/src/semi_empirical_int3_utils.F +++ b/src/semi_empirical_int3_utils.F @@ -42,7 +42,7 @@ CONTAINS !> \param ic ... !> \param itype ... !> \param eval ... -!> \retval res ... +!> \return ... !> \date 11.2008 [tlaino] !> \author Teodoro Laino [tlaino] ! ************************************************************************************************** @@ -115,7 +115,7 @@ CONTAINS !> \param l1 ... !> \param l2 ... !> \param add ... -!> \retval charg ... +!> \return ... !> \date 11.2008 [tlaino] !> \author Teodoro Laino [tlaino] ! ************************************************************************************************** @@ -149,7 +149,7 @@ CONTAINS !> \param l1 ... !> \param l2 ... !> \param add ... -!> \retval coeff ... +!> \return ... !> \date 11.2008 [tlaino] !> \author Teodoro Laino [tlaino] ! ************************************************************************************************** @@ -184,7 +184,7 @@ CONTAINS !> \param l1 ... !> \param l2 ... !> \param add ... -!> \retval charg ... +!> \return ... !> \date 11.2008 [tlaino] !> \author Teodoro Laino [tlaino] ! ************************************************************************************************** diff --git a/src/semi_empirical_int_debug.F b/src/semi_empirical_int_debug.F index 56d9fa57fe..0abd0d9b60 100644 --- a/src/semi_empirical_int_debug.F +++ b/src/semi_empirical_int_debug.F @@ -348,7 +348,7 @@ END SUBROUTINE check_dcore_nucint_ana !> \param ana ... !> \param minval ... !> \param thrs ... -!> \retval passed ... +!> \return ... !> \par History !> 04.2008 created [tlaino] !> \author Teodoro Laino - Zurich University diff --git a/src/semi_empirical_int_utils.F b/src/semi_empirical_int_utils.F index ccb45c5e14..187593a080 100644 --- a/src/semi_empirical_int_utils.F +++ b/src/semi_empirical_int_utils.F @@ -57,7 +57,7 @@ CONTAINS !> \param se_int_control ... !> \param se_int_screen ... !> \param itype ... -!> \retval res ... +!> \return ... !> \date 04.2008 [tlaino] !> \author Teodoro Laino [tlaino] - University of Zurich ! ************************************************************************************************** @@ -108,7 +108,7 @@ CONTAINS !> \param se_int_control ... !> \param se_int_screen ... !> \param itype ... -!> \retval res ... +!> \return ... !> \date 05.2008 [tlaino] !> \author Teodoro Laino [tlaino] - University of Zurich ! ************************************************************************************************** @@ -190,7 +190,7 @@ CONTAINS !> \param max_multipole ... !> \param itype ... !> \param eval a function without explicit interface -!> \retval res ... +!> \return ... !> \date 05.2008 [tlaino] !> \author Teodoro Laino [tlaino] - University of Zurich ! ************************************************************************************************** @@ -336,7 +336,7 @@ CONTAINS !> \param db_i ... !> \param add0 ... !> \param fact_screen ... -!> \retval charg ... +!> \return ... !> \date 04.2008 [tlaino] !> \author Teodoro Laino [tlaino] - University of Zurich ! ************************************************************************************************** @@ -540,7 +540,7 @@ CONTAINS !> \param db_i ... !> \param add0 ... !> \param fact_screen ... -!> \retval charg ... +!> \return ... !> \date 04.2008 [tlaino] !> \author Teodoro Laino [tlaino] - University of Zurich ! ************************************************************************************************** @@ -745,7 +745,7 @@ CONTAINS !> \param db_i ... !> \param add0 ... !> \param fact_screen ... -!> \retval charg ... +!> \return ... !> \date 04.2008 [tlaino] !> \author Teodoro Laino [tlaino] - University of Zurich ! ************************************************************************************************** @@ -957,7 +957,7 @@ CONTAINS !> \param se_int_control ... !> \param se_int_screen ... !> \param itype ... -!> \retval res ... +!> \return ... !> \date 03.2008 [tlaino] !> \author Teodoro Laino [tlaino] - University of Zurich ! ************************************************************************************************** @@ -1014,7 +1014,7 @@ CONTAINS !> \param se_int_control ... !> \param se_int_screen ... !> \param itype ... -!> \retval res ... +!> \return ... !> \date 03.2008 [tlaino] !> \author Teodoro Laino [tlaino] - University of Zurich ! ************************************************************************************************** @@ -1101,7 +1101,7 @@ CONTAINS !> \param max_multipole ... !> \param itype ... !> \param eval a function without explicit interface -!> \retval res ... +!> \return ... !> \date 03.2008 [tlaino] !> \author Teodoro Laino [tlaino] - University of Zurich ! ************************************************************************************************** @@ -1248,7 +1248,7 @@ CONTAINS !> \param db_i ... !> \param add0 ... !> \param fact_screen ... -!> \retval charg ... +!> \return ... !> \date 03.2008 [tlaino] !> \author Teodoro Laino [tlaino] - University of Zurich ! ************************************************************************************************** @@ -1383,7 +1383,7 @@ CONTAINS !> \param db_i ... !> \param add0 ... !> \param fact_screen ... -!> \retval charg ... +!> \return ... !> \date 03.2008 [tlaino] !> \author Teodoro Laino [tlaino] - University of Zurich ! ************************************************************************************************** @@ -1520,7 +1520,7 @@ CONTAINS !> \param db_i ... !> \param add0 ... !> \param fact_screen ... -!> \retval charg ... +!> \return ... !> \date 03.2008 [tlaino] !> \author Teodoro Laino [tlaino] - University of Zurich ! ************************************************************************************************** diff --git a/src/semi_empirical_par_utils.F b/src/semi_empirical_par_utils.F index 5a298592cd..0a318dd5b8 100644 --- a/src/semi_empirical_par_utils.F +++ b/src/semi_empirical_par_utils.F @@ -250,7 +250,7 @@ CONTAINS !> \brief Gives back the number of basis function for each l !> \param sep ... !> \param l ... -!> \retval n ... +!> \return ... ! ************************************************************************************************** FUNCTION get_se_basis(sep, l) RESULT(n) TYPE(semi_empirical_type), POINTER :: sep @@ -498,7 +498,7 @@ CONTAINS !> \brief Determines if the elements has d-orbitals !> !> \param sep ... -!> \retval res ... +!> \return ... !> \date 05.2008 [tlaino] !> \author Teodoro Laino [tlaino] - University of Zurich ! ************************************************************************************************** @@ -515,7 +515,7 @@ CONTAINS !> \brief Determines if the elements has f-orbitals !> !> \param sep ... -!> \retval res ... +!> \return ... !> \date 05.2008 [tlaino] !> \author Teodoro Laino [tlaino] - University of Zurich ! ************************************************************************************************** @@ -627,7 +627,7 @@ CONTAINS !> \param n1 ... !> \param n2 ... !> \param l ... -!> \retval amnl ... +!> \return ... !> \date 03.2008 [tlaino] !> \author Teodoro Laino [tlaino] - University of Zurich ! ************************************************************************************************** @@ -858,7 +858,7 @@ CONTAINS !> \param ec ... !> \param nd ... !> \param ed ... -!> \retval res ... +!> \return ... !> \date 03.2008 [tlaino] !> \par Notation !> -) k: Type of integral @@ -963,7 +963,7 @@ CONTAINS !> \param l ... !> \param d ... !> \param fg ... -!> \retval res ... +!> \return ... !> \date 03.2008 [tlaino] !> \author Teodoro Laino [tlaino] - University of Zurich ! ************************************************************************************************** diff --git a/src/semi_empirical_utils.F b/src/semi_empirical_utils.F index 45dfd54d2a..decfa718b7 100644 --- a/src/semi_empirical_utils.F +++ b/src/semi_empirical_utils.F @@ -342,7 +342,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Gives back the unique semi_empirical METHOD type !> \param se_method ... -!> \retval se_type ... +!> \return ... ! ************************************************************************************************** FUNCTION get_se_type(se_method) RESULT(se_type) diff --git a/src/spglib_f08.F b/src/spglib_f08.F index ddc667caf0..a15409ab30 100644 --- a/src/spglib_f08.F +++ b/src/spglib_f08.F @@ -138,7 +138,7 @@ !> \param types ... !> \param num_atom ... !> \param symprec ... -!> \retval spg_get_symmetry ... +!> \return ... ! ************************************************************************************************** FUNCTION spg_get_symmetry(rotation, translation, max_size, lattice, & position, types, num_atom, symprec) @@ -169,7 +169,7 @@ !> \param types ... !> \param num_atom ... !> \param symprec ... -!> \retval spg_get_multiplicity ... +!> \return ... ! ************************************************************************************************** FUNCTION spg_get_multiplicity(lattice, position, types, num_atom, symprec) REAL(KIND=dp), INTENT(in) :: lattice(:, :), position(:, :) @@ -194,7 +194,7 @@ !> \param types ... !> \param num_atom ... !> \param symprec ... -!> \retval spg_get_international ... +!> \return ... ! ************************************************************************************************** FUNCTION spg_get_international(symbol, lattice, position, types, num_atom, symprec) CHARACTER, INTENT(out) :: symbol(11) @@ -222,7 +222,7 @@ !> \param types ... !> \param num_atom ... !> \param symprec ... -!> \retval spg_get_schoenflies ... +!> \return ... ! ************************************************************************************************** FUNCTION spg_get_schoenflies(symbol, lattice, position, types, num_atom, symprec) CHARACTER, INTENT(out) :: symbol(7) @@ -248,7 +248,7 @@ !> \param trans_mat ... !> \param rotations ... !> \param num_rotations ... -!> \retval spg_get_pointgroup ... +!> \return ... ! ************************************************************************************************** FUNCTION spg_get_pointgroup(symbol, trans_mat, rotations, num_rotations) CHARACTER :: symbol(6) @@ -276,7 +276,7 @@ !> \param types ... !> \param num_atom ... !> \param symprec ... -!> \retval spg_get_ir_reciprocal_mesh ... +!> \return ... ! ************************************************************************************************** FUNCTION spg_get_ir_reciprocal_mesh(grid_point, map, mesh, & is_shift, is_time_reversal, lattice, position, types, num_atom, symprec) @@ -306,7 +306,7 @@ ! ************************************************************************************************** !> \brief ... -!> \retval spg_get_major_version ... +!> \return ... ! ************************************************************************************************** FUNCTION spg_get_major_version() INTEGER :: spg_get_major_version @@ -316,7 +316,7 @@ ! ************************************************************************************************** !> \brief ... -!> \retval spg_get_minor_version ... +!> \return ... ! ************************************************************************************************** FUNCTION spg_get_minor_version() INTEGER :: spg_get_minor_version @@ -326,7 +326,7 @@ ! ************************************************************************************************** !> \brief ... -!> \retval spg_get_micro_version ... +!> \return ... ! ************************************************************************************************** FUNCTION spg_get_micro_version() INTEGER :: spg_get_micro_version diff --git a/src/splines_methods.F b/src/splines_methods.F index d5c5a26886..ba3ef84ff4 100644 --- a/src/splines_methods.F +++ b/src/splines_methods.F @@ -149,7 +149,7 @@ CONTAINS !> \param y1 1. derivative at xx !> \param spl_f ... !> \param logger ... -!> \retval potential_s ... +!> \return ... !> \par Output !> spline interpolated value at xx !> \par History @@ -213,7 +213,7 @@ CONTAINS !> \param spl ... !> \param xx ... !> \param y1 ... -!> \retval spline_value ... +!> \return ... !> \author HAF ! ************************************************************************************************** FUNCTION spline_value(spl, xx, y1) diff --git a/src/start/cp2k_runs.F b/src/start/cp2k_runs.F index 4292d72ba2..c4a248c39f 100644 --- a/src/start/cp2k_runs.F +++ b/src/start/cp2k_runs.F @@ -149,7 +149,7 @@ CONTAINS !> \param input_file_name name of the file to be opened for input !> \param output_unit unit to which output should be written !> \param mpi_comm ... -!> \retval cp2k_run_OK ... +!> \return ... !> \author Joost VandeVondele !> \note !> para_env should be a valid communicator diff --git a/src/start/cp2k_shell.F b/src/start/cp2k_shell.F index 12e63286b4..a535f548a9 100644 --- a/src/start/cp2k_shell.F +++ b/src/start/cp2k_shell.F @@ -587,7 +587,7 @@ CONTAINS !> \param str ... !> \param startI ... !> \param default_val ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** FUNCTION parse_env_id(str,startI,default_val) RESULT(res) CHARACTER(LEN=*), INTENT(in) :: str @@ -614,7 +614,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param str ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** FUNCTION ll(str) RESULT(res) CHARACTER(LEN=*), INTENT(in) :: str @@ -669,7 +669,7 @@ CONTAINS ! ************************************************************************************************** !> \brief returns the number returned by iostat on eof -!> \retval res ... +!> \return ... ! ************************************************************************************************** FUNCTION get_eof_stat() RESULT(res) INTEGER :: res diff --git a/src/statistical_methods.F b/src/statistical_methods.F index e67857911e..467b8c5e9a 100644 --- a/src/statistical_methods.F +++ b/src/statistical_methods.F @@ -258,7 +258,7 @@ CONTAINS !> AS66 Applied Statistics (1973) vol.22, no.3 !> \param x ... !> \param upper ... -!> \retval fn_val ... +!> \return ... !> \par History !> Original version by Alain J. Miller - 1996 !> Teodoro Laino (02.2007) [tlaino] @@ -307,7 +307,7 @@ CONTAINS !> \param c ... !> \param nord ... !> \param x ... -!> \retval fn_val ... +!> \return ... !> \par History !> Original version by Alain J. Miller - 1996 !> Teodoro Laino (02.2007) [tlaino] diff --git a/src/subsys/atomic_kind_types.F b/src/subsys/atomic_kind_types.F index 67beac552e..4857e22af0 100644 --- a/src/subsys/atomic_kind_types.F +++ b/src/subsys/atomic_kind_types.F @@ -392,7 +392,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Determines if the atomic_kind is HYDROGEN !> \param atomic_kind ... -!> \retval res ... +!> \return ... !> \author Teodoro Laino [tlaino] - University of Zurich 10.2008 ! ************************************************************************************************** PURE FUNCTION is_hydrogen(atomic_kind) RESULT(res) diff --git a/src/subsys/cell_types.F b/src/subsys/cell_types.F index 6ba6a881ba..48bbd2b0a2 100644 --- a/src/subsys/cell_types.F +++ b/src/subsys/cell_types.F @@ -478,7 +478,7 @@ CONTAINS !> \param k ... !> \param l ... !> \param cell ... -!> \retval distance ... +!> \return ... !> \date 18.11.2004 !> \author Matthias Krack !> \version 1.0 @@ -542,7 +542,7 @@ CONTAINS !> cell to a position vector r. !> \param r ... !> \param cell ... -!> \retval r_pbc ... +!> \return ... !> \date 16.01.2002 !> \author Matthias Krack !> \version 1.0 @@ -579,7 +579,7 @@ CONTAINS !> \param r ... !> \param cell ... !> \param nl ... -!> \retval r_pbc ... +!> \return ... !> \date 16.01.2002 !> \author Matthias Krack !> \version 1.0 @@ -620,7 +620,7 @@ CONTAINS !> \param ra ... !> \param rb ... !> \param cell ... -!> \retval rab_pbc ... +!> \return ... !> \date 11.03.2004 !> \author Matthias Krack !> \version 1.0 @@ -668,7 +668,7 @@ CONTAINS !> \param r ... !> \param cell ... !> \param positive_range ... -!> \retval r_pbc ... +!> \return ... ! ************************************************************************************************** FUNCTION pbc4(r, cell, positive_range) RESULT(r_pbc) diff --git a/src/subsys/colvar_types.F b/src/subsys/colvar_types.F index 8fba9bc483..bb5e608cd6 100644 --- a/src/subsys/colvar_types.F +++ b/src/subsys/colvar_types.F @@ -1190,7 +1190,7 @@ CONTAINS !> \brief Gives back the size of an array of integer. If not associated gives back 1 !> \param colvar ... !> \param i ... -!> \retval my_size ... +!> \return ... !> \author Teodoro Laino - 03.2007 ! ************************************************************************************************** FUNCTION colv_size(colvar, i) RESULT(my_size) @@ -2012,7 +2012,7 @@ CONTAINS !> periodic/non-periodic colvar !> \param colvar ... !> \param b ... -!> \retval diff ... +!> \return ... !> \author Teodoro Laino [tlaino] - University of Zurich 10.2008 ! ************************************************************************************************** FUNCTION diff_colvar(colvar, b) RESULT(diff) diff --git a/src/subsys/particle_types.F b/src/subsys/particle_types.F index e302c9698c..d55dab7ff1 100644 --- a/src/subsys/particle_types.F +++ b/src/subsys/particle_types.F @@ -191,7 +191,7 @@ CONTAINS !> \param iatom ... !> \param particle_set ... !> \param vector ... -!> \retval x ... +!> \return ... !> \date 25.11.2010 !> \author Matthias Krack !> \version 1.0 diff --git a/src/swarm/glbopt_history.F b/src/swarm/glbopt_history.F index 864ee22601..feb9e53063 100644 --- a/src/swarm/glbopt_history.F +++ b/src/swarm/glbopt_history.F @@ -78,7 +78,7 @@ CONTAINS !> \brief Calculates a fingerprint for a given configuration. !> \param Epot ... !> \param pos ... -!> \retval fp ... +!> \return ... !> \author Ole Schuett ! ************************************************************************************************** FUNCTION history_fingerprint(Epot, pos) RESULT(fp) @@ -145,7 +145,7 @@ CONTAINS !> \param history ... !> \param fp1 ... !> \param fp2 ... -!> \retval res ... +!> \return ... !> \author Ole Schuett ! ************************************************************************************************** FUNCTION history_fingerprint_match(history, fp1, fp2) RESULT(res) @@ -163,7 +163,7 @@ CONTAINS !> Calulates the distance between two given fingerprints. !> \param fp1 ... !> \param fp2 ... -!> \retval res ... +!> \return ... !> \author Stefan Goedecker ! ************************************************************************************************** PURE FUNCTION fingerprint_distance(fp1, fp2) RESULT(res) @@ -292,7 +292,7 @@ CONTAINS !> \brief Helper routine for history_lookup !> \param history ... !> \param Efind ... -!> \retval res ... +!> \return ... !> \author Ole Schuett ! ************************************************************************************************** FUNCTION interpolation_search(history, Efind) RESULT(res) diff --git a/src/swarm/glbopt_mincrawl.F b/src/swarm/glbopt_mincrawl.F index 4699096a1d..26c3dc9856 100644 --- a/src/swarm/glbopt_mincrawl.F +++ b/src/swarm/glbopt_mincrawl.F @@ -221,7 +221,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Helper routine for mincrawl_steer, choses minimum based on its score. !> \param this ... -!> \retval minima ... +!> \return ... !> \author Ole Schuett ! ************************************************************************************************** FUNCTION choose_promising_minima(this) RESULT(minima) @@ -249,7 +249,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Helper routine for choose_promising_minima, calculates a minimum's score !> \param minima ... -!> \retval res ... +!> \return ... !> \author Ole Schuett ! ************************************************************************************************** FUNCTION minima_score(minima) RESULT(res) @@ -263,7 +263,7 @@ CONTAINS !> \brief Helper routine for mincrawl_steer, samples from a temp-dist. !> \param this ... !> \param minima ... -!> \retval step ... +!> \return ... !> \author Ole Schuett ! ************************************************************************************************** FUNCTION choose_tempstep(this, minima) RESULT(step) @@ -304,7 +304,7 @@ CONTAINS !> \brief Helper routine, convertes a discrete temp-step to a temperature. !> \param this ... !> \param step ... -!> \retval temp_in_au ... +!> \return ... !> \author Ole Schuett ! ************************************************************************************************** FUNCTION tempstep2temp(this, step) RESULT(temp_in_au) @@ -319,7 +319,7 @@ CONTAINS !> \brief Helper routine, convertes a temperature to a discrete temp-step. !> \param this ... !> \param temp_in_au ... -!> \retval step ... +!> \return ... !> \author Ole Schuett ! ************************************************************************************************** FUNCTION temp2tempstep(this, temp_in_au) RESULT(step) diff --git a/src/swarm/glbopt_worker.F b/src/swarm/glbopt_worker.F index 199b6ce07e..1ac2c5eaa1 100644 --- a/src/swarm/glbopt_worker.F +++ b/src/swarm/glbopt_worker.F @@ -272,7 +272,7 @@ CONTAINS !> \brief Helper routine for run_mdgopt, fixes a fragmented atomic cluster. !> \param positions ... !> \param bondlength ... -!> \retval all_connected ... +!> \return ... !> \author Stefan Goedecker ! ************************************************************************************************** FUNCTION fix_fragmentation(positions, bondlength) RESULT(all_connected) @@ -342,7 +342,7 @@ CONTAINS !> \param positions ... !> \param i ... !> \param j ... -!> \retval dr ... +!> \return ... !> \author Ole Schuett ! ************************************************************************************************** PURE FUNCTION diff(positions, i, j) RESULT(dr) @@ -356,7 +356,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Helper routine for fix_fragmentation, calulates vector norm !> \param vec ... -!> \retval res ... +!> \return ... !> \author Ole Schuett ! ************************************************************************************************** PURE FUNCTION norm(vec) RESULT(res) diff --git a/src/swarm/swarm_master.F b/src/swarm/swarm_master.F index 9a86c9555a..bb9d080358 100644 --- a/src/swarm/swarm_master.F +++ b/src/swarm/swarm_master.F @@ -201,7 +201,7 @@ CONTAINS !> \param cmd1 ... !> \param cmd2 ... !> \param iw ... -!> \retval res ... +!> \return ... !> \author Ole Schuett ! ************************************************************************************************** FUNCTION commands_equal(cmd1, cmd2, iw) RESULT(res) diff --git a/src/swarm/swarm_message.F b/src/swarm/swarm_message.F index 8e65f9565a..29ba263479 100644 --- a/src/swarm/swarm_message.F +++ b/src/swarm/swarm_message.F @@ -83,7 +83,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Returns the number of entries contained in a swarm-message. !> \param msg ... -!> \retval l ... +!> \return ... !> \author Ole Schuett ! ************************************************************************************************** FUNCTION swarm_message_length(msg) RESULT(l) @@ -104,7 +104,7 @@ CONTAINS !> \brief Checks if a swarm-message contains an entry with the given key. !> \param msg ... !> \param key ... -!> \retval res ... +!> \return ... !> \author Ole Schuett ! ************************************************************************************************** FUNCTION swarm_message_haskey(msg, key) RESULT(res) @@ -163,7 +163,7 @@ CONTAINS !> \brief Checks if two swarm-messages are equal !> \param msg1 ... !> \param msg2 ... -!> \retval res ... +!> \return ... !> \author Ole Schuett ! ************************************************************************************************** FUNCTION swarm_message_equal(msg1, msg2) RESULT(res) @@ -364,7 +364,7 @@ CONTAINS !> \brief Helper routine for swarm_message_equal !> \param msg1 ... !> \param msg2 ... -!> \retval res ... +!> \return ... !> \author Ole Schuett ! ************************************************************************************************** FUNCTION swarm_message_equal_oneway(msg1, msg2) RESULT(res) @@ -835,7 +835,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Helper routine, converts a string into an integer-array !> \param str ... -!> \retval arr ... +!> \return ... !> \author Ole Schuett ! ************************************************************************************************** PURE FUNCTION str2iarr(str) RESULT(arr) @@ -852,7 +852,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Helper routine, converts an integer-array into a string !> \param arr ... -!> \retval str ... +!> \return ... !> \author Ole Schuett ! ************************************************************************************************** PURE FUNCTION iarr2str(arr) RESULT(str) diff --git a/src/swarm/swarm_mpi.F b/src/swarm/swarm_mpi.F index 87c9e92435..6742e941d3 100644 --- a/src/swarm/swarm_mpi.F +++ b/src/swarm/swarm_mpi.F @@ -182,7 +182,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Helper routine for logger_init_master, inquires filename for given unit. !> \param output_unit ... -!> \retval output_path ... +!> \return ... !> \author Ole Schuett ! ************************************************************************************************** FUNCTION output_unit2path(output_unit) RESULT(output_path) diff --git a/src/taper_types.F b/src/taper_types.F index 9250f9e2b2..9999e5d026 100644 --- a/src/taper_types.F +++ b/src/taper_types.F @@ -75,7 +75,7 @@ CONTAINS !> \brief Taper functions !> \param taper ... !> \param rij ... -!> \retval ft ... +!> \return ... ! ************************************************************************************************** FUNCTION taper_eval(taper, rij) RESULT(ft) TYPE(taper_type), POINTER :: taper @@ -97,7 +97,7 @@ CONTAINS !> \brief Analytical derivatives for taper function !> \param taper ... !> \param rij ... -!> \retval dft ... +!> \return ... ! ************************************************************************************************** FUNCTION dtaper_eval(taper, rij) RESULT(dft) TYPE(taper_type), POINTER :: taper diff --git a/src/task_list_methods.F b/src/task_list_methods.F index 2ea50b8d7d..5986786df4 100644 --- a/src/task_list_methods.F +++ b/src/task_list_methods.F @@ -646,7 +646,7 @@ CONTAINS !> \param fraction ... !> \param lmax ... !> \param is_ortho ... -!> \retval cost_model ... +!> \return ... ! ************************************************************************************************** INTEGER FUNCTION cost_model(lb_cube, ub_cube, fraction, lmax, is_ortho) INTEGER, DIMENSION(3), INTENT(IN) :: lb_cube, ub_cube @@ -1381,7 +1381,7 @@ CONTAINS !> \param list ... !> \param rank ... !> \param dest ... -!> \retval list_index ... +!> \return ... !> \par History !> created 2008-10-06 [Joost VandeVondele] ! ************************************************************************************************** @@ -2702,7 +2702,7 @@ CONTAINS !> \param rank ... !> \param grid_level ... !> \param n_levels ... -!> \retval encoded_int ... +!> \return ... !> \par History !> 4.2009 created [Iain Bethune] !> (c) The Numerical Algorithms Group (NAG) Ltd, 2009 on behalf of the HECToR project @@ -2722,7 +2722,7 @@ CONTAINS !> \brief ... !> \param encoded_int ... !> \param n_levels ... -!> \retval rank ... +!> \return ... ! ************************************************************************************************** FUNCTION decode_rank(encoded_int, n_levels) RESULT(rank) @@ -2738,7 +2738,7 @@ CONTAINS !> \brief ... !> \param encoded_int ... !> \param n_levels ... -!> \retval grid_level ... +!> \return ... ! ************************************************************************************************** FUNCTION decode_level(encoded_int, n_levels) RESULT(grid_level) diff --git a/src/tmc/tmc_analysis_types.F b/src/tmc/tmc_analysis_types.F index ce4e215cd3..67d6db793b 100644 --- a/src/tmc/tmc_analysis_types.F +++ b/src/tmc/tmc_analysis_types.F @@ -319,7 +319,7 @@ CONTAINS !> \param n1 atom names !> \param n2 atom names !> \param list_end ... -!> \retval ind ... +!> \return ... !> \author Mandes 02.2013 ! ************************************************************************************************** FUNCTION search_pair_in_list(pair_list, n1, n2, list_end) RESULT(ind) diff --git a/src/tmc/tmc_calculations.F b/src/tmc/tmc_calculations.F index 3c37678705..47dabfed5e 100644 --- a/src/tmc/tmc_calculations.F +++ b/src/tmc/tmc_calculations.F @@ -236,7 +236,7 @@ CONTAINS !> \param x2 ... !> \param cell ... !> \param box_scale ... -!> \retval res ... +!> \return ... !> \author Mandes 11.2012 ! ************************************************************************************************** FUNCTION nearest_distance(x1, x2, cell, box_scale) RESULT(res) @@ -396,7 +396,7 @@ CONTAINS !> and atom mass, both in atomic units !> \param vel ... !> \param atoms ... -!> \retval ekin ... +!> \return ... !> \author Mandes 11.2012 ! ************************************************************************************************** FUNCTION calc_e_kin(vel, atoms) RESULT(ekin) @@ -506,7 +506,7 @@ CONTAINS !> energies !> \param p the random number, the criteria has to be smaller than this !> \param beta ... -!> \retval prob return probability of acceptance +!> \return return probability of acceptance !> \author Mandes 12.2012 ! ************************************************************************************************** FUNCTION compute_prob(E_n_mu, E_n_sigma, E_o_mu, E_o_sigma, E_classical_diff, & @@ -537,7 +537,7 @@ CONTAINS !> \param rnd_nr random number acceptance check will be done with !> \param beta 1/(kB*T) can differ for different acceptance checks !> \param tmc_params TMC environment parameters -!> \retval prob estimated acceptance probability +!> \return estimated acceptance probability !> \author Mandes 12.2012 ! ************************************************************************************************** FUNCTION compute_estimated_prob(elem_old, elem_new, E_classical_diff, & diff --git a/src/tmc/tmc_dot_tree.F b/src/tmc/tmc_dot_tree.F index 9c17efe1d4..ee484e996c 100644 --- a/src/tmc/tmc_dot_tree.F +++ b/src/tmc/tmc_dot_tree.F @@ -48,7 +48,7 @@ CONTAINS !> \brief returns extended filename for global and sub trees !> \param tmc_params param environment for creating the file name !> \param ind index of the subtree (0 = global tree) -!> \retval filename ... +!> \return ... !> \author Mandes 12.2012 ! ************************************************************************************************** FUNCTION get_dot_file_name(tmc_params, ind) RESULT(filename) diff --git a/src/tmc/tmc_file_io.F b/src/tmc/tmc_file_io.F index 3fe2c9caa8..5141433c2b 100644 --- a/src/tmc/tmc_file_io.F +++ b/src/tmc/tmc_file_io.F @@ -66,7 +66,7 @@ CONTAINS !> (instead of the ending) !> \param file_name original file name !> \param extra string to be added before the file extention -!> \retval result_file_name the new filename +!> \return the new filename !> \author Mandes 11.2012 ! ************************************************************************************************** FUNCTION expand_file_name_ending(file_name, extra) RESULT(result_file_name) @@ -96,7 +96,7 @@ CONTAINS !> (before the file extention) !> \param file_name original file name !> \param extra string to be added before the file extention -!> \retval result_file_name the new filename +!> \return the new filename !> \author Mandes 11.2012 ! ************************************************************************************************** FUNCTION expand_file_name_char(file_name, extra) RESULT(result_file_name) @@ -126,7 +126,7 @@ CONTAINS !> (before the file extention) !> \param file_name original file name !> \param rvalue temperature to be added -!> \retval result_file_name the new filename +!> \return the new filename !> \author Mandes 11.2012 ! ************************************************************************************************** FUNCTION expand_file_name_temp(file_name, rvalue) RESULT(result_file_name) @@ -166,7 +166,7 @@ CONTAINS !> (before the file extention) !> \param file_name original file name !> \param ivalue number to be added -!> \retval result_file_name the new filename +!> \return the new filename !> \author Mandes 11.2012 ! ************************************************************************************************** FUNCTION expand_file_name_int(file_name, ivalue) RESULT(result_file_name) diff --git a/src/tmc/tmc_messages.F b/src/tmc/tmc_messages.F index 2a9fe0025e..957f8a1450 100644 --- a/src/tmc/tmc_messages.F +++ b/src/tmc/tmc_messages.F @@ -80,7 +80,7 @@ CONTAINS ! ************************************************************************************************** !> \brief checks if the core is the group master !> \param para_env defines the mpi communicator -!> \retval master return value, logical +!> \return return value, logical !> \author Mandes 01.2013 ! ************************************************************************************************** FUNCTION check_if_group_master(para_env) RESULT(master) diff --git a/src/tmc/tmc_move_handle.F b/src/tmc/tmc_move_handle.F index 03bc53f47c..fd28ad234f 100644 --- a/src/tmc/tmc_move_handle.F +++ b/src/tmc/tmc_move_handle.F @@ -874,7 +874,7 @@ CONTAINS !> \brief selects a move type related to the weighings and the entered rnd nr !> \param move_types structure for storing sizes and probabilities of moves !> \param rnd random number -!> \retval mv_type (result) move type +!> \return (result) move type !> \author Mandes 12.2012 !> \note function returns a possible move type without the PT swap moves !> \note (are selected in global tree, this routine is for sub tree elements) diff --git a/src/tmc/tmc_moves.F b/src/tmc/tmc_moves.F index 742f822249..bf5654f6d1 100644 --- a/src/tmc/tmc_moves.F +++ b/src/tmc/tmc_moves.F @@ -412,7 +412,7 @@ CONTAINS !> \param subbox_center actual center of sub box !> \param box_scale scaling factors for the cell !> \param tmc_params TMC parameters with sub box size and cell -!> \retval inside ... +!> \return ... !> \author Mandes 11.2012 ! ************************************************************************************************** FUNCTION check_pos_in_subbox(pos, subbox_center, box_scale, tmc_params) & @@ -905,7 +905,7 @@ CONTAINS !> \param i_orig ... !> \param i_neighbor ... !> \param tmc_params ... -!> \retval donor_acceptor ... +!> \return ... !> \author Mandes 11.2012 ! ************************************************************************************************** FUNCTION check_donor_acceptor(elem, i_orig, i_neighbor, tmc_params) & diff --git a/src/tmc/tmc_tree_acceptance.F b/src/tmc/tmc_tree_acceptance.F index 40b5785150..aabb6febdd 100644 --- a/src/tmc/tmc_tree_acceptance.F +++ b/src/tmc/tmc_tree_acceptance.F @@ -872,7 +872,7 @@ CONTAINS !> \brief checks if element is ready for accaptance probability update !> checks status and the amount of already received intermediate energies !> \param elem sub tree element to update -!> \retval ready return value +!> \return return value !> \author Mandes 12.2012 ! ************************************************************************************************** FUNCTION ready_for_update_acc_prob(elem) RESULT(ready) diff --git a/src/tmc/tmc_tree_search.F b/src/tmc/tmc_tree_search.F index b799cceacd..d5afbbc67c 100644 --- a/src/tmc/tmc_tree_search.F +++ b/src/tmc/tmc_tree_search.F @@ -271,7 +271,7 @@ CONTAINS ! ************************************************************************************************** !> \brief searching the parent element (last accepted configuration before) !> \param current actual tree element -!> \retval parent parent tree element (last accepted one) +!> \return parent tree element (last accepted one) !> \author Mandes 12.2012 !> \note routine searches last (assumed) accepted element in subtree ! ************************************************************************************************** diff --git a/src/topology_amber.F b/src/topology_amber.F index bdf57fd01a..61dea1902a 100644 --- a/src/topology_amber.F +++ b/src/topology_amber.F @@ -1284,7 +1284,7 @@ CONTAINS !> \param parser ... !> \param section ... !> \param input_format ... -!> \retval another_section ... +!> \return ... !> \author Teodoro Laino [tlaino] - University of Zurich 10.2008 ! ************************************************************************************************** FUNCTION get_section_parmtop(parser, section, input_format) RESULT(another_section) @@ -1324,7 +1324,7 @@ CONTAINS !> \brief Check the version of the AMBER topology file (we can handle from v8 on) !> \param parser ... !> \param output_unit ... -!> \retval found_AMBER_V8 ... +!> \return ... !> \author Teodoro Laino [tlaino] - University of Zurich 10.2008 ! ************************************************************************************************** FUNCTION check_amber_8_std(parser, output_unit) RESULT(found_AMBER_V8) diff --git a/src/topology_generate_util.F b/src/topology_generate_util.F index bf8d07540c..5e616c749f 100644 --- a/src/topology_generate_util.F +++ b/src/topology_generate_util.F @@ -927,7 +927,7 @@ CONTAINS !> \param atom_info ... !> \param bondparm_factor ... !> \param output_unit ... -!> \retval conn_ok ... +!> \return ... !> \author Teodoro Laino 09.2006 ! ************************************************************************************************** FUNCTION check_generate_mol(bond_a, bond_b, atom_info, bondparm_factor, output_unit) & diff --git a/src/wannier90.F b/src/wannier90.F index 13ee8ca2a1..d111bdfed9 100644 --- a/src/wannier90.F +++ b/src/wannier90.F @@ -690,7 +690,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param dist ... -!> \retval internal_maxloc ... +!> \return ... ! ************************************************************************************************** FUNCTION internal_maxloc(dist) !=========================================================================! diff --git a/src/xc/cp_linked_list_xc_deriv.F b/src/xc/cp_linked_list_xc_deriv.F index eedaa56d19..28270c31e6 100644 --- a/src/xc/cp_linked_list_xc_deriv.F +++ b/src/xc/cp_linked_list_xc_deriv.F @@ -25,7 +25,7 @@ USE xc_derivative_types, ONLY: xc_derivative_type,xc_derivative_p_type !> \brief private compare function !> \param el1 ... !> \param el2 ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** function cp_sll_deriv_less_q(el1,el2) result(res) type(xc_derivative_type), pointer :: el1,el2 diff --git a/src/xc/xc.F b/src/xc/xc.F index 305824c924..d48347d71f 100644 --- a/src/xc/xc.F +++ b/src/xc/xc.F @@ -1805,7 +1805,7 @@ CONTAINS !> \param tau ... !> \param xc_section ... !> \param pw_pool ... -!> \retval exc ... +!> \return ... !> \par History !> 11.2003 created [fawzi] !> \author fawzi diff --git a/src/xc/xc_b97.F b/src/xc/xc_b97.F index 7799d4f5f9..4df41008af 100644 --- a/src/xc/xc_b97.F +++ b/src/xc/xc_b97.F @@ -504,7 +504,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param param ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** FUNCTION b97_coeffs(param) RESULT(res) INTEGER, INTENT(in) :: param diff --git a/src/xc/xc_derivative_set_types.F b/src/xc/xc_derivative_set_types.F index e91da01532..fdc47bf2de 100644 --- a/src/xc/xc_derivative_set_types.F +++ b/src/xc/xc_derivative_set_types.F @@ -61,7 +61,7 @@ CONTAINS !> \param description the description of the derivative you want to have !> \param allocate_deriv if the derivative should be allocated when not present !> Defaults to false. -!> \retval res ... +!> \return ... ! ************************************************************************************************** FUNCTION xc_dset_get_derivative(derivative_set, description, allocate_deriv) & RESULT(res) diff --git a/src/xc/xc_derivatives.F b/src/xc/xc_derivatives.F index 2af2852492..b66df0000f 100644 --- a/src/xc/xc_derivatives.F +++ b/src/xc/xc_derivatives.F @@ -619,7 +619,7 @@ CONTAINS !> \param add_basic_components makes sure that if some gradient combination !> is needed also the gradient components are requested, and if lsd !> is true rho_spin is requested. Defaults to false. -!> \retval needs ... +!> \return ... !> \author fawzi ! ************************************************************************************************** FUNCTION xc_functionals_get_needs(functionals, lsd, add_basic_components) & diff --git a/src/xc/xc_libxc_wrap.F b/src/xc/xc_libxc_wrap.F index 3f76e53c5e..95a980294f 100644 --- a/src/xc/xc_libxc_wrap.F +++ b/src/xc/xc_libxc_wrap.F @@ -229,7 +229,7 @@ CONTAINS ! ************************************************************************************************** !> \brief Provides the functional ID. !> \param func_string ... -!> \retval func_id ... +!> \return ... !> \author A. Gloess (agloess) !> \note Remove prefix to keep compatibility, functionals can be specified (in !> LIBXC section) as: @@ -266,7 +266,7 @@ CONTAINS !> a dummy array. !> \param func_id ... !> -!> \retval xc_libxc_wrap_needs_laplace ... +!> \return ... !> \author A. Gloess (agloess) ! ************************************************************************************************** LOGICAL FUNCTION xc_libxc_wrap_needs_laplace(func_id) diff --git a/src/xc/xc_rho_cflags_types.F b/src/xc/xc_rho_cflags_types.F index 85e8025a26..e70ee964a0 100644 --- a/src/xc/xc_rho_cflags_types.F +++ b/src/xc/xc_rho_cflags_types.F @@ -84,7 +84,7 @@ CONTAINS !> \brief return true if the two cflags are equal !> \param cflags1 the flags to compare !> \param cflags2 the flags to compare -!> \retval equal ... +!> \return ... ! ************************************************************************************************** FUNCTION xc_rho_cflags_equal(cflags1, cflags2) RESULT(equal) TYPE(xc_rho_cflags_type), INTENT(in) :: cflags1, cflags2 diff --git a/src/xc/xc_xpbe_hole_t_c_lr.F b/src/xc/xc_xpbe_hole_t_c_lr.F index 4c77eca5c4..f48a48bc82 100644 --- a/src/xc/xc_xpbe_hole_t_c_lr.F +++ b/src/xc/xc_xpbe_hole_t_c_lr.F @@ -1105,7 +1105,7 @@ CONTAINS !> rho and norm_drho. !> \param P = 9/4*s^2*H/A !> \param Q = s^2*H*R^2*kf^2 -!> \retval exei ... +!> \return ... !> \par History !> 01.2009 created [Manuel Guidon] !> \author Manuel Guidon @@ -1164,7 +1164,7 @@ CONTAINS !> \param Q ... !> \param dPrho ... !> \param dQrho ... -!> \retval dexeirho ... +!> \return ... ! ************************************************************************************************** FUNCTION dexeirho(P, Q, dPrho, dQrho) REAL(dp), INTENT(IN) :: P, Q, dPrho, dQrho @@ -1179,7 +1179,7 @@ CONTAINS !> \param Q ... !> \param dPndrho ... !> \param dQndrho ... -!> \retval dexeindrho ... +!> \return ... ! ************************************************************************************************** FUNCTION dexeindrho(P, Q, dPndrho, dQndrho) REAL(dp), INTENT(IN) :: P, Q, dPndrho, dQndrho @@ -1192,7 +1192,7 @@ CONTAINS !> \brief ... !> \param rho ... !> \param ndrho ... -!> \retval red ... +!> \return ... ! ************************************************************************************************** FUNCTION red(rho, ndrho) REAL(dp), INTENT(IN) :: rho, ndrho @@ -1207,7 +1207,7 @@ CONTAINS !> \brief ... !> \param rho ... !> \param ndrho ... -!> \retval dsdrho ... +!> \return ... ! ************************************************************************************************** FUNCTION dsdrho(rho, ndrho) REAL(dp), INTENT(IN) :: rho, ndrho @@ -1221,7 +1221,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param rho ... -!> \retval dsdndrho ... +!> \return ... ! ************************************************************************************************** FUNCTION dsdndrho(rho) REAL(dp), INTENT(IN) :: rho diff --git a/src/xc/xc_xwpbe.F b/src/xc/xc_xwpbe.F index b3b1219566..92f3da0f32 100644 --- a/src/xc/xc_xwpbe.F +++ b/src/xc/xc_xwpbe.F @@ -5488,7 +5488,7 @@ CONTAINS !> \param Q , dQrho, dQndrho, d2Qrhondrho : !> Argument Q and derivatives with respect to various combinations of !> rho and norm_drho -!> \retval exei ... +!> \return ... !> \par History !> 05.2007 created [Manuel Guidon] !> \author Manuel Guidon @@ -5515,7 +5515,7 @@ CONTAINS ! ************************************************************************************************** !> \brief ... !> \param Q ... -!> \retval exer ... +!> \return ... ! ************************************************************************************************** FUNCTION exer(Q) REAL(dp), INTENT(IN) :: Q @@ -5539,7 +5539,7 @@ CONTAINS !> \brief ... !> \param Q ... !> \param dQrho ... -!> \retval dexeirho ... +!> \return ... ! ************************************************************************************************** FUNCTION dexeirho(Q, dQrho) REAL(dp), INTENT(IN) :: Q, dQrho @@ -5552,7 +5552,7 @@ CONTAINS !> \brief ... !> \param Q ... !> \param dQndrho ... -!> \retval dexeindrho ... +!> \return ... ! ************************************************************************************************** FUNCTION dexeindrho(Q, dQndrho) REAL(dp), INTENT(IN) :: Q, dQndrho @@ -5565,7 +5565,7 @@ CONTAINS !> \brief ... !> \param Q ... !> \param dQrho ... -!> \retval dexerrho ... +!> \return ... ! ************************************************************************************************** FUNCTION dexerrho(Q, dQrho) REAL(dp), INTENT(IN) :: Q, dQrho @@ -5578,7 +5578,7 @@ CONTAINS !> \brief ... !> \param Q ... !> \param dQndrho ... -!> \retval dexerndrho ... +!> \return ... ! ************************************************************************************************** FUNCTION dexerndrho(Q, dQndrho) REAL(dp), INTENT(IN) :: Q, dQndrho @@ -5592,7 +5592,7 @@ CONTAINS !> \param Q ... !> \param dQrho ... !> \param d2Qrhorho ... -!> \retval d2exeirhorho ... +!> \return ... ! ************************************************************************************************** FUNCTION d2exeirhorho(Q, dQrho, d2Qrhorho) REAL(dp), INTENT(IN) :: Q, dQrho, d2Qrhorho @@ -5607,7 +5607,7 @@ CONTAINS !> \param Q ... !> \param dQrho ... !> \param d2Qrhorho ... -!> \retval d2exerrhorho ... +!> \return ... ! ************************************************************************************************** FUNCTION d2exerrhorho(Q, dQrho, d2Qrhorho) REAL(dp), INTENT(IN) :: Q, dQrho, d2Qrhorho @@ -5628,7 +5628,7 @@ CONTAINS !> \param dQrho ... !> \param dQndrho ... !> \param d2Qrhondrho ... -!> \retval d2exeirhondrho ... +!> \return ... ! ************************************************************************************************** FUNCTION d2exeirhondrho(Q, dQrho, dQndrho, d2Qrhondrho) REAL(dp), INTENT(IN) :: Q, dQrho, dQndrho, d2Qrhondrho @@ -5644,7 +5644,7 @@ CONTAINS !> \param dQrho ... !> \param dQndrho ... !> \param d2Qrhondrho ... -!> \retval d2exerrhondrho ... +!> \return ... ! ************************************************************************************************** FUNCTION d2exerrhondrho(Q, dQrho, dQndrho, d2Qrhondrho) REAL(dp), INTENT(IN) :: Q, dQrho, dQndrho, d2Qrhondrho @@ -5664,7 +5664,7 @@ CONTAINS !> \param Q ... !> \param dQndrho ... !> \param d2Qndrhondrho ... -!> \retval d2exeindrhondrho ... +!> \return ... ! ************************************************************************************************** FUNCTION d2exeindrhondrho(Q, dQndrho, d2Qndrhondrho) REAL(dp), INTENT(IN) :: Q, dQndrho, d2Qndrhondrho @@ -5679,7 +5679,7 @@ CONTAINS !> \param Q ... !> \param dQndrho ... !> \param d2Qndrhondrho ... -!> \retval d2exerndrhondrho ... +!> \return ... ! ************************************************************************************************** FUNCTION d2exerndrhondrho(Q, dQndrho, d2Qndrhondrho) REAL(dp), INTENT(IN) :: Q, dQndrho, d2Qndrhondrho diff --git a/src/xc_pot_saop.F b/src/xc_pot_saop.F index f174f4e274..d1496295aa 100644 --- a/src/xc_pot_saop.F +++ b/src/xc_pot_saop.F @@ -1156,7 +1156,7 @@ CONTAINS !> \param ec_unif ... !> \param rc ... !> \param ngrc ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** FUNCTION calc_ecpbe_u(ra, rb, ngr, ec_unif, rc, ngrc) RESULT(res) @@ -1195,7 +1195,7 @@ CONTAINS !> \param ec_unif ... !> \param rc ... !> \param ngrc ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** FUNCTION calc_ecpbe_r(r, ngr, ec_unif, rc, ngrc) RESULT(res) @@ -1225,7 +1225,7 @@ CONTAINS !> \param ngr ... !> \param rc ... !> \param ngrc ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** FUNCTION calc_expbe_u(ra, rb, ngr, rc, ngrc) RESULT(res) @@ -1245,7 +1245,7 @@ CONTAINS !> \param ngr ... !> \param rc ... !> \param ngrc ... -!> \retval res ... +!> \return ... ! ************************************************************************************************** FUNCTION calc_expbe_r(r, ngr, rc, ngrc) RESULT(res) diff --git a/tools/doxify/fixcomments.pl b/tools/doxify/fixcomments.pl index 4672653f79..e15a711500 100755 --- a/tools/doxify/fixcomments.pl +++ b/tools/doxify/fixcomments.pl @@ -74,6 +74,7 @@ my ($hasParam, $hasAuthor, $hasNote, $hasRetVal, + $hasReturn, $hasRandom, $hasRemainder); @@ -87,6 +88,7 @@ my (%params, $authors, $notes, $retVals, + $returns, $randoms, $remainders); @@ -100,7 +102,7 @@ my $hasAmpersand = 0; my $inParentheses = 0; # Whether the procedure definition contains the RETURN value -my $hasRetValAsArg = 0; +my $hasReturnAsArg = 0; # Keeps track of which parameters in the current procedure have # a matching doxygen header @@ -219,6 +221,7 @@ sub initVariables { $authors = $EMPTY; $notes = $EMPTY; $retVals = $EMPTY; + $returns = $EMPTY; $randoms = $EMPTY; $remainders = $EMPTY; $buffer = $EMPTY; @@ -377,6 +380,16 @@ sub processDoxygenHeader { $retVals = $retVals . $currline; initToggles(); $hasRetVal = 1; + } elsif ($currline =~ m/!>\s\\returns\s*/xms) { + print_debug("Got return header"); + $returns = $returns . $currline; + initToggles(); + $hasReturn = 1; + } elsif ($currline =~ m/!>\s\\return\s*/xms) { + print_debug("Got return header"); + $returns = $returns . $currline; + initToggles(); + $hasReturn = 1; } elsif ($currline =~ m/!>\s\\\S+/xms) { # Randoms contains anything else that looks # like a DOXYGEN header. with a \whatever @@ -416,6 +429,8 @@ sub processDoxygenHeader { $notes = $notes . $currline; } elsif ($hasRetVal) { $retVals = $retVals . $currline; + } elsif ($hasReturn) { + $returns = $returns . $currline; } elsif ($hasRandom) { # Must check to see if line has already been commented if (($currline !~ m/UNKNOWN_DOXYGEN_COMMENT/xms) && @@ -496,7 +511,7 @@ sub processSubroutineDefinition { chomp($functionLine); $hasAmpersand = 0; - $hasRetValAsArg = 0; + $hasReturnAsArg = 0; my $lelement = $EMPTY; # Split the subroutine or function definition by space or comma @@ -525,17 +540,17 @@ sub processSubroutineDefinition { if ($inParentheses) { print_debug("In parentheses, parameter: $p, previous parameter: $lelement"); # Must have either a parameter of a function return value - if (($lelement =~ m/RESULT/ixms) && ($hasRetValAsArg)) { + if (($lelement =~ m/RESULT/ixms) && ($hasReturnAsArg)) { print_debug("Got return parameter $p"); - if ($retVals eq $EMPTY) { + if ($returns eq $EMPTY) { # If the previous element was RESULT outside of # parantheses then this element must be whatever # gets returned by the procedure. - # if no retval data is available print out the ... + # if no return data is available print out the ... # to header # Only stored for now so it is always printed # in the same place (after the \params) - $retVals = "!> \\retval $p ...\n"; + $returns = "!> \\return ...\n"; } } else { # Must be parameter @@ -595,7 +610,7 @@ sub processSubroutineDefinition { } elsif ($p =~ m/RESULT/ixms) { # Check to see if parameter is RESULT for a FUNCTION print_debug("Need to get function result parameter"); - $hasRetValAsArg = 1; + $hasReturnAsArg = 1; } } $lelement = $p; # Take a note of the array element for comparison, ignoring & and () @@ -631,15 +646,19 @@ sub processSubroutineDefinition { # If after looping through the elements there is no ampersand # we close off the comment and write out the procedure definition if (!($hasAmpersand)) { - if ($retVals ne $EMPTY) { + if ($returns ne $EMPTY) { # Print RESULT value first so that it should come straight after the \param definitions - print $OUTPUT $retVals; + print $OUTPUT $returns; } else { # Get return value from function name if ($isFunction) { - print $OUTPUT "!> \\retval $procedureName ...\n"; + print $OUTPUT "!> \\return ...\n"; } } + if ($retVals ne $EMPTY) { + # Print return values definitions second so that they come after any \return definitions + print $OUTPUT $retVals; + } if (($dates eq $EMPTY) || ($dates eq "!> \\date\n")) { # dates entry empty or exists and contains no text ### print $OUTPUT "!> \\date MISSING_COMMENT: Unknown\n"; # Use this line if you want to add text to the entry