From 192a15764a9e6286d94ca17f4a1b1e7b7c8b56f3 Mon Sep 17 00:00:00 2001 From: Even Rouault Date: Fri, 5 Jun 2020 17:22:44 +0200 Subject: Doc: use Doxygen output for proj_normalize_for_visualization() to avoid duplication of info (current .rst content is outdated) --- docs/source/development/reference/functions.rst | 22 ++-------------------- src/proj.h | 2 ++ 2 files changed, 4 insertions(+), 20 deletions(-) diff --git a/docs/source/development/reference/functions.rst b/docs/source/development/reference/functions.rst index d5611c9a..e092c4a0 100644 --- a/docs/source/development/reference/functions.rst +++ b/docs/source/development/reference/functions.rst @@ -172,26 +172,8 @@ paragraph for more details. :param `options`: should be set to NULL currently. -.. c:function:: PJ *proj_normalize_for_visualization(PJ_CONTEXT *ctx, const PJ* obj) - - .. versionadded:: 6.1.0 - - Returns a PJ* object whose axis order is the one expected for - visualization purposes. - - The input object must be a coordinate operation, that has been created with - proj_create_crs_to_crs(). - If the axis order of its source or target CRS is northing,easting, then an - axis swap operation will be inserted. - - The returned :c:type:`PJ`-pointer should be deallocated with :c:func:`proj_destroy`. - - :param ctx: Threading context. - :type ctx: :c:type:`PJ_CONTEXT` * - :param `obj`: Object of type CoordinateOperation - :type `obj`: const :c:type:`PJ` * - :returns: :c:type:`PJ` * - +.. doxygenfunction:: proj_normalize_for_visualization + :project: doxygen_api .. c:function:: PJ* proj_destroy(PJ *P) diff --git a/src/proj.h b/src/proj.h index 19a81163..330ab01e 100644 --- a/src/proj.h +++ b/src/proj.h @@ -546,7 +546,9 @@ PJ PROJ_DLL *proj_create_crs_to_crs_from_pj(PJ_CONTEXT *ctx, const PJ *target_crs, PJ_AREA *area, const char* const *options); +/*! @endcond Doxygen_Suppress */ PJ PROJ_DLL *proj_normalize_for_visualization(PJ_CONTEXT *ctx, const PJ* obj); +/*! @cond Doxygen_Suppress */ void PROJ_DLL proj_assign_context(PJ* pj, PJ_CONTEXT* ctx); PJ PROJ_DLL *proj_destroy (PJ *P); -- cgit v1.2.3