+doc,htp #18496 improved parameter docs a bit

This commit is contained in:
Konrad Malawski 2015-10-08 16:26:29 +02:00
parent afcd3e2127
commit 745a1c458f
4 changed files with 15 additions and 13 deletions

View file

@ -3,6 +3,8 @@
parameter
=========
Extracts a *query* parameter value from the request.
An alias for :ref:`-parameters-`.
Signature
@ -14,7 +16,9 @@ Signature
Description
-----------
See :ref:`-parameters-`
See :ref:`-parameters-` for a detailed description of this directive.
See :ref:`which-parameter-directive` to understand when to use which directive.
Example
-------

View file

@ -17,9 +17,7 @@ Description
If a query contains a parameter value several times, the map will contain the last one.
See :ref:`which-parameter-directive` for other
choices.
See :ref:`which-parameter-directive` to understand when to use which directive.
Example
-------

View file

@ -18,7 +18,7 @@ Description
This directive can be used if parameters can occur several times. The order of values is
not specified.
See :ref:`which-parameter-directive` for other choices.
See :ref:`which-parameter-directive` to understand when to use which directive.
Example
-------

View file

@ -59,49 +59,49 @@ Examples
--------
Required parameter
++++++++++++++++++
^^^^^^^^^^^^^^^^^^
.. includecode2:: ../../../../code/docs/http/scaladsl/server/directives/ParameterDirectivesExamplesSpec.scala
:snippet: required-1
Optional parameter
++++++++++++++++++
^^^^^^^^^^^^^^^^^^
.. includecode2:: ../../../../code/docs/http/scaladsl/server/directives/ParameterDirectivesExamplesSpec.scala
:snippet: optional
Optional parameter with default value
+++++++++++++++++++++++++++++++++++++
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. includecode2:: ../../../../code/docs/http/scaladsl/server/directives/ParameterDirectivesExamplesSpec.scala
:snippet: optional-with-default
Parameter with required value
+++++++++++++++++++++++++++++
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. includecode2:: ../../../../code/docs/http/scaladsl/server/directives/ParameterDirectivesExamplesSpec.scala
:snippet: required-value
Deserialized parameter
++++++++++++++++++++++
^^^^^^^^^^^^^^^^^^^^^^
.. includecode2:: ../../../../code/docs/http/scaladsl/server/directives/ParameterDirectivesExamplesSpec.scala
:snippet: mapped-value
Repeated parameter
++++++++++++++++++
^^^^^^^^^^^^^^^^^^
.. includecode2:: ../../../../code/docs/http/scaladsl/server/directives/ParameterDirectivesExamplesSpec.scala
:snippet: repeated
Csv valued parameter
++++++++++++++++++++
^^^^^^^^^^^^^^^^^^^^
.. includecode2:: ../../../../code/docs/http/scaladsl/server/directives/ParameterDirectivesExamplesSpec.scala
:snippet: csv
Repeated, deserialized parameter
++++++++++++++++++++++++++++++++
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. includecode2:: ../../../../code/docs/http/scaladsl/server/directives/ParameterDirectivesExamplesSpec.scala
:snippet: mapped-repeated