diff options
| author | Joris Van den Bossche <jorisvandenbossche@gmail.com> | 2019-04-10 11:38:23 +0200 |
|---|---|---|
| committer | Kristian Evers <kristianevers@gmail.com> | 2019-04-10 11:38:23 +0200 |
| commit | fb125618fd18f112ed6f37662b021d07a602ff90 (patch) | |
| tree | cea6994e4f877df4f67b7d946ba6f708d0d31e24 /docs | |
| parent | 309eab8fd741d09d836f41252a0eda49f3793520 (diff) | |
| download | PROJ-fb125618fd18f112ed6f37662b021d07a602ff90.tar.gz PROJ-fb125618fd18f112ed6f37662b021d07a602ff90.zip | |
DOC: add sphinx links to reference in dev quickstart (#1420)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/source/development/quickstart.rst | 34 |
1 files changed, 17 insertions, 17 deletions
diff --git a/docs/source/development/quickstart.rst b/docs/source/development/quickstart.rst index 267270fb..b6c5d17c 100644 --- a/docs/source/development/quickstart.rst +++ b/docs/source/development/quickstart.rst @@ -28,7 +28,7 @@ See the :doc:`reference for more info on data types <reference/datatypes>`. :lines: 43-45 :dedent: 4 -For use in multi-threaded programs the ``PJ_CONTEXT`` threading-context is used. +For use in multi-threaded programs the :c:type:`PJ_CONTEXT` threading-context is used. In this particular example it is not needed, but for the sake of completeness it created here. The section on :doc:`threads <threads>` discusses this in detail. @@ -38,15 +38,15 @@ this in detail. :lines: 49 :dedent: 4 -Next we create the ``PJ`` transformation object ``P`` with the function -``proj_create``. ``proj_create`` takes the threading context ``C`` created above, -and a proj-string that defines the desired transformation. Here we transform -from geodetic coordinate to UTM zone 32N. +Next we create the :c:type:`PJ` transformation object ``P`` with the function +:c:func:`proj_create`. :c:func:`proj_create` takes the threading context ``C`` +created above, and a proj-string that defines the desired transformation. +Here we transform from geodetic coordinate to UTM zone 32N. It is recommended to create one threading-context per thread used by the program. -This ensures that all ``PJ`` objects created in the same context will be sharing -resources such as error-numbers and loaded grids. -In case the creation of the ``PJ`` object fails an error message is displayed and -the program returns. See :doc:`errorhandling` for further +This ensures that all :c:type:`PJ` objects created in the same context will be +sharing resources such as error-numbers and loaded grids. +In case the creation of the :c:type:`PJ` object fails an error message is +displayed and the program returns. See :doc:`errorhandling` for further details. .. literalinclude:: ../../../examples/pj_obs_api_mini_demo.c @@ -55,9 +55,9 @@ details. :dedent: 4 PROJ uses it's own data structures for handling coordinates. Here we use a -``PJ_COORD`` which is easily assigned with the function ``proj_coord``. Note -that the input values are converted to radians with ``proj_torad``. This is -necessary since PROJ is using radians internally. See :doc:`transformations` +:c:type:`PJ_COORD` which is easily assigned with the function :c:func:`proj_coord`. +Note that the input values are converted to radians with :c:func:`proj_torad`. +This is necessary since PROJ is using radians internally. See :doc:`transformations` for further details. .. literalinclude:: ../../../examples/pj_obs_api_mini_demo.c @@ -65,10 +65,10 @@ for further details. :lines: 57 :dedent: 4 -The coordinate defined above is transformed with ``proj_trans``. For this -a ``PJ`` object, a transformation direction (either forward or inverse) and the -coordinate is needed. The transformed coordinate is returned in ``b``. -Here the forward (``PJ_FWD``) transformation from geodetic to UTM is made. +The coordinate defined above is transformed with :c:func:`proj_trans`. For this +a :c:type:`PJ` object, a transformation direction (either forward or inverse) +and the coordinate is needed. The transformed coordinate is returned in ``b``. +Here the forward (:c:type:`PJ_FWD`) transformation from geodetic to UTM is made. .. literalinclude:: ../../../examples/pj_obs_api_mini_demo.c :language: c @@ -76,7 +76,7 @@ Here the forward (``PJ_FWD``) transformation from geodetic to UTM is made. :dedent: 4 The inverse transformation (UTM to geodetic) is done similar to above, -this time using ``PJ_INV`` as the direction. +this time using :c:type:`PJ_INV` as the direction. .. literalinclude:: ../../../examples/pj_obs_api_mini_demo.c :language: c |
