Commit 4564ebf8 authored by gbyte.co's avatar gbyte.co

Add code documentation

parent 60b09f4d
...@@ -29,6 +29,9 @@ as well. On top of that custom links can be added to the sitemap. ...@@ -29,6 +29,9 @@ as well. On top of that custom links can be added to the sitemap.
To learn about XML sitemaps, see https://en.wikipedia.org/wiki/Sitemaps. To learn about XML sitemaps, see https://en.wikipedia.org/wiki/Sitemaps.
The module also provides an API allowing to create any type of sitemap (not
necessary an XML one) holding links to a local or remote source.
## INSTALLATION ## ## INSTALLATION ##
See https://www.drupal.org/documentation/install/modules-themes/modules-8 See https://www.drupal.org/documentation/install/modules-themes/modules-8
......
...@@ -498,6 +498,13 @@ class Simplesitemap { ...@@ -498,6 +498,13 @@ class Simplesitemap {
* @param string|null $bundle_name * @param string|null $bundle_name
* Limit the result set to a specific bundle name. * Limit the result set to a specific bundle name.
* *
* @param bool $supplement_defaults
* Supplements the result set with default custom link settings.
*
* @param bool $multiple_variants
* If true, returns an array of results keyed by variant name, otherwise it
* returns the result set for the first variant only.
*
* @return array|false * @return array|false
* Array of settings or array of settings keyed by variant name. False if * Array of settings or array of settings keyed by variant name. False if
* entity type does not exist. * entity type does not exist.
......
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