mirror of
https://github.com/RSS-Bridge/rss-bridge.git
synced 2025-08-06 08:37:30 +02:00
Fix header formatting
@@ -11,9 +11,9 @@ The `FormatInterface`interface defines functions that need to be implemented by
|
|||||||
|
|
||||||
Find a [template](#template) at the end of this file
|
Find a [template](#template) at the end of this file
|
||||||
|
|
||||||
#Functions
|
# Functions
|
||||||
|
|
||||||
##The `display` function
|
## The `display` function
|
||||||
|
|
||||||
The `display` function shows the contents to the user and must return the object instance.
|
The `display` function shows the contents to the user and must return the object instance.
|
||||||
|
|
||||||
@@ -21,7 +21,7 @@ The `display` function shows the contents to the user and must return the object
|
|||||||
display(): self
|
display(): self
|
||||||
```
|
```
|
||||||
|
|
||||||
##The `stringify` function
|
## The `stringify` function
|
||||||
|
|
||||||
The `stringify` function returns the items received by [`setItems`](#the-setitem-function) as string.
|
The `stringify` function returns the items received by [`setItems`](#the-setitem-function) as string.
|
||||||
|
|
||||||
@@ -29,7 +29,7 @@ The `stringify` function returns the items received by [`setItems`](#the-setitem
|
|||||||
stringify(): string
|
stringify(): string
|
||||||
```
|
```
|
||||||
|
|
||||||
##The `setItems` function
|
## The `setItems` function
|
||||||
|
|
||||||
The `setItems` function receives an array of items generated by the bridge and must return the object instance. Each item represents an entry in the feed. For more information refer to [BridgeAbstract](BridgeAbstract#items).
|
The `setItems` function receives an array of items generated by the bridge and must return the object instance. Each item represents an entry in the feed. For more information refer to [BridgeAbstract](BridgeAbstract#items).
|
||||||
|
|
||||||
@@ -37,7 +37,7 @@ The `setItems` function receives an array of items generated by the bridge and m
|
|||||||
setItems(array $items): self
|
setItems(array $items): self
|
||||||
```
|
```
|
||||||
|
|
||||||
##The `getItems` function
|
## The `getItems` function
|
||||||
|
|
||||||
The `getItems` function returns the items previously set by the [`setItems`](FormatInterface#the-setitems-function) function. If no items where set previously this function returns an error.
|
The `getItems` function returns the items previously set by the [`setItems`](FormatInterface#the-setitems-function) function. If no items where set previously this function returns an error.
|
||||||
|
|
||||||
@@ -45,7 +45,7 @@ The `getItems` function returns the items previously set by the [`setItems`](For
|
|||||||
getItems(): array
|
getItems(): array
|
||||||
```
|
```
|
||||||
|
|
||||||
##The `setCharset` function
|
## The `setCharset` function
|
||||||
|
|
||||||
The `setCharset` function receives the character set value as string and returns the object instance.
|
The `setCharset` function receives the character set value as string and returns the object instance.
|
||||||
|
|
||||||
@@ -53,7 +53,7 @@ The `setCharset` function receives the character set value as string and returns
|
|||||||
setCharset(string): self
|
setCharset(string): self
|
||||||
```
|
```
|
||||||
|
|
||||||
##The `getCharset` function
|
## The `getCharset` function
|
||||||
|
|
||||||
The `getCharset` function returns the character set value.
|
The `getCharset` function returns the character set value.
|
||||||
|
|
||||||
@@ -61,7 +61,7 @@ The `getCharset` function returns the character set value.
|
|||||||
getCharset(): string
|
getCharset(): string
|
||||||
```
|
```
|
||||||
|
|
||||||
##The `setExtraInfos` function
|
## The `setExtraInfos` function
|
||||||
|
|
||||||
The `setExtraInfos` function receives an array of elements with additional information to generate format outputs and must return the object instance.
|
The `setExtraInfos` function receives an array of elements with additional information to generate format outputs and must return the object instance.
|
||||||
|
|
||||||
@@ -76,7 +76,7 @@ Name | Description
|
|||||||
`name` | Defines the name as generated by the bridge
|
`name` | Defines the name as generated by the bridge
|
||||||
`uri` | Defines the URI of the feed as generated by the bridge
|
`uri` | Defines the URI of the feed as generated by the bridge
|
||||||
|
|
||||||
##The `getExtraInfos` function
|
## The `getExtraInfos` function
|
||||||
|
|
||||||
The `getExtraInfos` function returns the information previously set via the [`setExtraInfos`](#the-setextrainfos-function) function.
|
The `getExtraInfos` function returns the information previously set via the [`setExtraInfos`](#the-setextrainfos-function) function.
|
||||||
|
|
||||||
@@ -84,7 +84,7 @@ The `getExtraInfos` function returns the information previously set via the [`se
|
|||||||
getExtraInfos(): array
|
getExtraInfos(): array
|
||||||
```
|
```
|
||||||
|
|
||||||
#Template
|
# Template
|
||||||
|
|
||||||
This is a bare minimum template for a format:
|
This is a bare minimum template for a format:
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user