From: Wolfgang Bangerth Date: Mon, 12 Mar 2018 03:21:40 +0000 (-0600) Subject: Improve readability of doxygen-generated pages. X-Git-Tag: v9.0.0-rc1~328^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F6040%2Fhead;p=dealii.git Improve readability of doxygen-generated pages. --- diff --git a/include/deal.II/grid/grid_tools.h b/include/deal.II/grid/grid_tools.h index 541d541f32..5025fd0e71 100644 --- a/include/deal.II/grid/grid_tools.h +++ b/include/deal.II/grid/grid_tools.h @@ -625,7 +625,7 @@ namespace GridTools * @param[in] cache The triangulation's GridTools::Cache . * @param[in] points The point's vector. * - * @param[out] Tuple containing the following information: + * @return A tuple containing the following information: * - Cells, is a vector of a vector cells of the all cells * containing at least one of the @p points . * - A vector qpoints of vector of points, containing in @p qpoints[i] @@ -645,13 +645,27 @@ namespace GridTools * Pre-sorting points, trying to minimize distances between them, might make the function * extremely faster. * + * @note The actual return type of this function, i.e., the type referenced + * above as @p return_type, is + * @code + * std::tuple< + * std::vector::active_cell_iterator >, + * std::vector< std::vector< Point > >, + * std::vector< std::vector > > + * @endcode + * The type is abbreviated above to improve readability of this page. + * * @author Giovanni Alzetta, 2017 */ template +#ifndef DOXYGEN std::tuple< std::vector::active_cell_iterator >, std::vector< std::vector< Point > >, std::vector< std::vector > > +#else + return_type +#endif compute_point_locations(const Cache &cache, const std::vector > &points, const typename Triangulation::active_cell_iterator &cell_hint @@ -673,7 +687,7 @@ namespace GridTools * @param[in] local_bbox the description of the locally owned part of the mesh made * with bounding boxes. It can be obtained from * GridTools::compute_mesh_predicate_bounding_box - * @param[out] tuple containing the quadrature information + * @return A tuple containing the quadrature information * * The elements of the output tuple are: * - cells : a vector of cells of the all cells containing at @@ -698,9 +712,23 @@ namespace GridTools * In a serial execution the first three elements of the tuple are the same * as in GridTools::compute_point_locations . * + * @note The actual return type of this function, i.e., the type referenced + * above as @p return_type, is + * @code + * std::tuple< + * std::vector< typename Triangulation::active_cell_iterator >, + * std::vector< std::vector< Point > >, + * std::vector< std::vector< unsigned int > >, + * std::vector< std::vector< Point > >, + * std::vector< std::vector< unsigned int > > + * > + * @endcode + * The type is abbreviated above to improve readability of this page. + * * @author Giovanni Alzetta, 2017-2018 */ template +#ifndef DOXYGEN std::tuple< std::vector< typename Triangulation::active_cell_iterator >, std::vector< std::vector< Point > >, @@ -708,6 +736,9 @@ namespace GridTools std::vector< std::vector< Point > >, std::vector< std::vector< unsigned int > > > +#else + return_type +#endif distributed_compute_point_locations (const GridTools::Cache &cache, const std::vector > &local_points, @@ -1352,7 +1383,7 @@ namespace GridTools * mesh with a property for each process. * @param[in] points Array of points to test. * - * @param[out] A tuple containing the following information: + * @return A tuple containing the following information: * - A vector indicized with ranks of processes. For each rank it contains * a vector of the indices of points it might own. * - A map from the index unsigned int of the point in @p points @@ -1360,12 +1391,25 @@ namespace GridTools * - A map from the index unsigned int of the point in @p points * to the ranks of the guessed owners. * + * @note The actual return type of this function, i.e., the type referenced + * above as @p return_type, is + * @code + * std::tuple< std::vector< std::vector< unsigned int > >, + * std::map< unsigned int, unsigned int>, + * std::map< unsigned int, std::vector< unsigned int > > > + * @endcode + * The type is abbreviated above to improve readability of this page. + * * @author Giovanni Alzetta, 2017 */ template +#ifndef DOXYGEN std::tuple< std::vector< std::vector< unsigned int > >, std::map< unsigned int, unsigned int>, std::map< unsigned int, std::vector< unsigned int > > > +#else + return_type +#endif guess_point_owner (const std::vector< std::vector< BoundingBox > > &global_bboxes, const std::vector< Point > &points);