=htc,doc #18496 make all directive docs have the same style, some
additions
This commit is contained in:
parent
bb053bea2a
commit
cddb1ade40
103 changed files with 212 additions and 335 deletions
|
|
@ -3,9 +3,6 @@
|
|||
getFromBrowseableDirectories
|
||||
============================
|
||||
|
||||
Serves the content of the given directories as a file system browser,
|
||||
i.e. files are sent and directories served as *browsable* listings.
|
||||
|
||||
Signature
|
||||
---------
|
||||
|
||||
|
|
|
|||
|
|
@ -3,9 +3,6 @@
|
|||
getFromBrowseableDirectory
|
||||
==========================
|
||||
|
||||
Serves the content of the given directory as a file system browser,
|
||||
i.e. files are sent and directories served as *browsable* listings.
|
||||
|
||||
Signature
|
||||
---------
|
||||
|
||||
|
|
|
|||
|
|
@ -3,8 +3,6 @@
|
|||
getFromDirectory
|
||||
================
|
||||
|
||||
Completes GET requests with the content of a file underneath the given directory.
|
||||
|
||||
Signature
|
||||
---------
|
||||
|
||||
|
|
|
|||
|
|
@ -3,8 +3,6 @@
|
|||
getFromFile
|
||||
===========
|
||||
|
||||
Completes GET requests with the content of the given file.
|
||||
|
||||
Signature
|
||||
---------
|
||||
|
||||
|
|
|
|||
|
|
@ -3,8 +3,6 @@
|
|||
getFromResource
|
||||
===============
|
||||
|
||||
Completes GET requests with the content of the given classpath resource.
|
||||
|
||||
Signature
|
||||
---------
|
||||
|
||||
|
|
@ -16,7 +14,7 @@ Description
|
|||
|
||||
Completes GET requests with the content of the given classpath resource.
|
||||
|
||||
For details refer to :ref:`getFromFile` which works the same way but obtaining the file from the filesystem
|
||||
For details refer to :ref:`-getFromFile-` which works the same way but obtaining the file from the filesystem
|
||||
instead of the applications classpath.
|
||||
|
||||
Note that it's not required to wrap this directive with ``get`` as this directive will only respond to ``GET`` requests.
|
||||
|
|
|
|||
|
|
@ -3,8 +3,6 @@
|
|||
getFromResourceDirectory
|
||||
========================
|
||||
|
||||
Completes GET requests with the content of the given classpath resource directory.
|
||||
|
||||
Signature
|
||||
---------
|
||||
|
||||
|
|
@ -16,7 +14,7 @@ Description
|
|||
|
||||
Completes GET requests with the content of the given classpath resource directory.
|
||||
|
||||
For details refer to :ref:`getFromDirectory` which works the same way but obtaining the file from the filesystem
|
||||
For details refer to :ref:`-getFromDirectory-` which works the same way but obtaining the file from the filesystem
|
||||
instead of the applications classpath.
|
||||
|
||||
Note that it's not required to wrap this directive with ``get`` as this directive will only respond to ``GET`` requests.
|
||||
|
|
|
|||
|
|
@ -3,9 +3,6 @@
|
|||
listDirectoryContents
|
||||
=====================
|
||||
|
||||
Completes GET requests with a unified listing of the contents of all given directories. The actual rendering of the
|
||||
directory contents is performed by the in-scope `Marshaller[DirectoryListing]`.
|
||||
|
||||
Signature
|
||||
---------
|
||||
|
||||
|
|
@ -15,11 +12,12 @@ Signature
|
|||
Description
|
||||
-----------
|
||||
|
||||
The ``listDirectoryContents`` directive renders a response only for directories.
|
||||
Completes GET requests with a unified listing of the contents of all given directories. The actual rendering of the
|
||||
directory contents is performed by the in-scope ``Marshaller[DirectoryListing]``.
|
||||
|
||||
To just serve files use :ref:`-getFromDirectory-`.
|
||||
|
||||
To serve files and provide a browseable directory listing use :ref:`-getFromBrowsableDirectories-` instead.
|
||||
To serve files and provide a browseable directory listing use :ref:`-getFromBrowseableDirectories-` instead.
|
||||
|
||||
The rendering can be overridden by providing a custom ``Marshaller[DirectoryListing]``, you can read more about it in
|
||||
:ref:`-getFromDirectory-` 's documentation.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue