Commit 450551d3 authored by GILLES Sebastien's avatar GILLES Sebastien

#1484 Move two Doxygen files outside of Internal directories... and shave off...

#1484 Move two Doxygen files outside of Internal directories... and shave off this way 3/4 of the warnings I got in the first place!
parent e229abc2
/*!
* \class doxygen_hide_geometry_format_read_common_arg
*
* \param[in] mesh The \a Mesh being build that called the present function. It is
* there only because a reference to the mnesh is required to build a \a MeshLabel.
* \param[in] file Path to the file being read.
* \copydoc doxygen_hide_space_unit_arg
* \param[out] dimension Number of components considered in the Coords objects. It is format_dependant: Ensight
* always returns 3 regarless of rthe mesh considered whereas Medit may return 2 or 3.
* \param[out] unsort_element_list List of geometric elements read in the file. No specific order is expected here;
* \a Mesh will anyway reorder them for its own needs.
* \param[out] coords_list List of \a Coords objects read in the file.
* \param[out] mesh_label_list List of \a MeshLabels read in the file.
*/
/*!
* \class doxygen_hide_geometry_format_write_common_arg
*
* \param[in] mesh Mesh to be written on the disk.
* \param[in] mesh_file Path to the file into which the mesh is to be written.
*/
/*!
* \class doxygen_hide_geometry_format_ensight_support
*
* \brief Provides relevant informations for Ensight support.
*
* \internal <b><tt>[internal]</tt></b> The parent true_type is extremely important: the operator bool()
* it defines is used within TGeometricElt to check whether the GeometricElt can be manipulated by
* Ensight or not.
*/
/*!
* \class doxygen_hide_geometry_format_medit_support
*
* \brief Provides relevant informations for Medit support.
*
* \internal <b><tt>[internal]</tt></b> The parent true_type is extremely important: the operator bool()
* it defines is used within TGeometricElt to check whether the GeometricElt can be manipulated by
* Medit or not.
*/
/*!
* \class doxygen_hide_is_on_local_vertex
*
* \brief Tells whether a given \a LocalCoords is located on a given local vertex.
*
* \param[in] local_vertex_index Index of the vertex being investigated. This index must be in
* range [0, Nvertex - 1]. For instance it must be in [0, 3] for a Quadrangle.
* \param[in] local_coords \a LocalCoords which position is tested.
*
* \return True if \a local_coords is located on the \a local_vertex_index -th vertex.
*/
/*!
* \class doxygen_hide_is_on_local_edge
*
* \brief Tells whether a given \a LocalCoords is located on a given local edge.
*
* \param[in] local_edge_index Index of the edge being investigated. This index must be in
* range [0, Nedge - 1]. For instance it must be in [0, 3] for a Quadrangle.
* \param[in] local_coords \a LocalCoords which position is tested.
*
* \return True if \a local_coords is located on the \a local_edge_index -th edge (included the
* delimitating vertex).
*/
/*!
* \class doxygen_hide_is_on_local_face
*
* \brief Tells whether a given \a LocalCoords is located on a given local face.
*
* \param[in] local_face_index Index of the face being investigated. This index must be in
* range [0, Nface - 1]. For instance it must be in [0, 6] for a Hexahedron.
* \param[in] local_coords \a LocalCoords which position is tested.
*
* \return True if \a local_coords is located on the \a local_face_index -th face (included the
* delimitating vertex and edges).
*/
/*!
* \class doxygen_hide_transform_face_point
*
* \brief Take a point on a face and transform it applying one of the possible transformations.
*
* \param[in] coords Local coordinates of the point before the transformation.
* \param[in] face_index Face on which the coords is.
* \param[in] orientation Index of the orientation to apply.
*
* \return LocalCoords obtained after the transformation.
*/
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment