Skip to content
This repository was archived by the owner on Dec 19, 2023. It is now read-only.

Commit 4814e4c

Browse files
committed
Updated documentation to reflect latest changes 086085c
1 parent ff28d21 commit 4814e4c

9 files changed

+28
-28
lines changed

api/Syndian.Instance.RSSArticle.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@
66
<meta charset="utf-8">
77
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
88
<title>Class RSSArticle
9-
| Syndian API - Aptivi Internals </title>
9+
| Syndian API - Aptivi </title>
1010
<meta name="viewport" content="width=device-width">
1111
<meta name="title" content="Class RSSArticle
12-
| Syndian API - Aptivi Internals ">
12+
| Syndian API - Aptivi ">
1313

1414
<link rel="shortcut icon" href="../favicon.ico">
1515
<link rel="stylesheet" href="../styles/docfx.vendor.min.css">

api/Syndian.Instance.RSSFeed.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@
66
<meta charset="utf-8">
77
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
88
<title>Class RSSFeed
9-
| Syndian API - Aptivi Internals </title>
9+
| Syndian API - Aptivi </title>
1010
<meta name="viewport" content="width=device-width">
1111
<meta name="title" content="Class RSSFeed
12-
| Syndian API - Aptivi Internals ">
12+
| Syndian API - Aptivi ">
1313

1414
<link rel="shortcut icon" href="../favicon.ico">
1515
<link rel="stylesheet" href="../styles/docfx.vendor.min.css">

api/Syndian.Instance.RSSFeedType.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@
66
<meta charset="utf-8">
77
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
88
<title>Enum RSSFeedType
9-
| Syndian API - Aptivi Internals </title>
9+
| Syndian API - Aptivi </title>
1010
<meta name="viewport" content="width=device-width">
1111
<meta name="title" content="Enum RSSFeedType
12-
| Syndian API - Aptivi Internals ">
12+
| Syndian API - Aptivi ">
1313

1414
<link rel="shortcut icon" href="../favicon.ico">
1515
<link rel="stylesheet" href="../styles/docfx.vendor.min.css">

api/Syndian.Instance.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@
66
<meta charset="utf-8">
77
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
88
<title>Namespace Syndian.Instance
9-
| Syndian API - Aptivi Internals </title>
9+
| Syndian API - Aptivi </title>
1010
<meta name="viewport" content="width=device-width">
1111
<meta name="title" content="Namespace Syndian.Instance
12-
| Syndian API - Aptivi Internals ">
12+
| Syndian API - Aptivi ">
1313

1414
<link rel="shortcut icon" href="../favicon.ico">
1515
<link rel="stylesheet" href="../styles/docfx.vendor.min.css">

api/Syndian.RSSTools.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@
66
<meta charset="utf-8">
77
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
88
<title>Class RSSTools
9-
| Syndian API - Aptivi Internals </title>
9+
| Syndian API - Aptivi </title>
1010
<meta name="viewport" content="width=device-width">
1111
<meta name="title" content="Class RSSTools
12-
| Syndian API - Aptivi Internals ">
12+
| Syndian API - Aptivi ">
1313

1414
<link rel="shortcut icon" href="../favicon.ico">
1515
<link rel="stylesheet" href="../styles/docfx.vendor.min.css">

api/Syndian.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@
66
<meta charset="utf-8">
77
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
88
<title>Namespace Syndian
9-
| Syndian API - Aptivi Internals </title>
9+
| Syndian API - Aptivi </title>
1010
<meta name="viewport" content="width=device-width">
1111
<meta name="title" content="Namespace Syndian
12-
| Syndian API - Aptivi Internals ">
12+
| Syndian API - Aptivi ">
1313

1414
<link rel="shortcut icon" href="../favicon.ico">
1515
<link rel="stylesheet" href="../styles/docfx.vendor.min.css">

index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55
<head>
66
<meta charset="utf-8">
77
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
8-
<title>What is Syndian? | Syndian API - Aptivi Internals </title>
8+
<title>What is Syndian? | Syndian API - Aptivi </title>
99
<meta name="viewport" content="width=device-width">
10-
<meta name="title" content="What is Syndian? | Syndian API - Aptivi Internals ">
10+
<meta name="title" content="What is Syndian? | Syndian API - Aptivi ">
1111

1212
<link rel="shortcut icon" href="favicon.ico">
1313
<link rel="stylesheet" href="styles/docfx.vendor.min.css">

index.json

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,37 @@
11
{
22
"api/Syndian.Instance.RSSArticle.html": {
33
"href": "api/Syndian.Instance.RSSArticle.html",
4-
"title": "Class RSSArticle | Syndian API - Aptivi Internals",
4+
"title": "Class RSSArticle | Syndian API - Aptivi",
55
"keywords": "Class RSSArticle RSS article instance Inheritance object RSSArticle Namespace: Syndian.Instance Assembly: Syndian.dll Syntax public class RSSArticle Properties | Edit this page View Source ArticleDescription RSS Article Descirption Declaration public string ArticleDescription { get; } Property Value Type Description string | Edit this page View Source ArticleLink RSS Article Link Declaration public string ArticleLink { get; } Property Value Type Description string | Edit this page View Source ArticleTitle RSS Article Title Declaration public string ArticleTitle { get; } Property Value Type Description string | Edit this page View Source ArticleVariables RSS Article Parameters Declaration public Dictionary<string, XmlNode> ArticleVariables { get; } Property Value Type Description Dictionary<string, XmlNode>"
66
},
77
"api/Syndian.Instance.RSSFeed.html": {
88
"href": "api/Syndian.Instance.RSSFeed.html",
9-
"title": "Class RSSFeed | Syndian API - Aptivi Internals",
9+
"title": "Class RSSFeed | Syndian API - Aptivi",
1010
"keywords": "Class RSSFeed RSS feed class instance Inheritance object RSSFeed Namespace: Syndian.Instance Assembly: Syndian.dll Syntax public class RSSFeed Constructors | Edit this page View Source RSSFeed(string, RSSFeedType) Makes a new instance of an RSS feed class Declaration public RSSFeed(string FeedUrl, RSSFeedType FeedType) Parameters Type Name Description string FeedUrl A URL to RSS feed RSSFeedType FeedType A feed type to parse. If set to Infer, it will automatically detect the type based on contents. Properties | Edit this page View Source FeedArticles Feed articles Declaration public List<RSSArticle> FeedArticles { get; } Property Value Type Description List<RSSArticle> | Edit this page View Source FeedDescription RSS feed description (Atom feeds not supported and always return an empty string) Declaration public string FeedDescription { get; } Property Value Type Description string | Edit this page View Source FeedTitle RSS feed type Declaration public string FeedTitle { get; } Property Value Type Description string | Edit this page View Source FeedType RSS feed type Declaration public RSSFeedType FeedType { get; } Property Value Type Description RSSFeedType | Edit this page View Source FeedUrl A URL to RSS feed Declaration public string FeedUrl { get; } Property Value Type Description string Methods | Edit this page View Source Refresh() Refreshes the RSS class instance Declaration public void Refresh() | Edit this page View Source Refresh(string, RSSFeedType) Refreshes the RSS class instance Declaration public void Refresh(string FeedUrl, RSSFeedType FeedType) Parameters Type Name Description string FeedUrl A URL to RSS feed RSSFeedType FeedType A feed type to parse. If set to Infer, it will automatically detect the type based on contents. | Edit this page View Source RefreshAsync() Refreshes the RSS class instance Declaration public Task RefreshAsync() Returns Type Description Task | Edit this page View Source RefreshAsync(string, RSSFeedType) Refreshes the RSS class instance Declaration public Task RefreshAsync(string FeedUrl, RSSFeedType FeedType) Parameters Type Name Description string FeedUrl A URL to RSS feed RSSFeedType FeedType A feed type to parse. If set to Infer, it will automatically detect the type based on contents. Returns Type Description Task"
1111
},
1212
"api/Syndian.Instance.RSSFeedType.html": {
1313
"href": "api/Syndian.Instance.RSSFeedType.html",
14-
"title": "Enum RSSFeedType | Syndian API - Aptivi Internals",
14+
"title": "Enum RSSFeedType | Syndian API - Aptivi",
1515
"keywords": "Enum RSSFeedType Enumeration for RSS feed type Namespace: Syndian.Instance Assembly: Syndian.dll Syntax public enum RSSFeedType Fields Name Description Atom The RSS format is Atom Infer Try to infer RSS type RSS1 The RSS format is RSS 1.0 RSS2 The RSS format is RSS 2.0"
1616
},
1717
"api/Syndian.Instance.html": {
1818
"href": "api/Syndian.Instance.html",
19-
"title": "Namespace Syndian.Instance | Syndian API - Aptivi Internals",
19+
"title": "Namespace Syndian.Instance | Syndian API - Aptivi",
2020
"keywords": "Namespace Syndian.Instance Classes RSSArticle RSS article instance RSSFeed RSS feed class instance Enums RSSFeedType Enumeration for RSS feed type"
2121
},
2222
"api/Syndian.RSSTools.html": {
2323
"href": "api/Syndian.RSSTools.html",
24-
"title": "Class RSSTools | Syndian API - Aptivi Internals",
24+
"title": "Class RSSTools | Syndian API - Aptivi",
2525
"keywords": "Class RSSTools The RSS tools Inheritance object RSSTools Namespace: Syndian Assembly: Syndian.dll Syntax public static class RSSTools Methods | Edit this page View Source GetFeedProperty(string, XmlNodeList, RSSFeedType) Gets a feed property Declaration public static object GetFeedProperty(string FeedProperty, XmlNodeList FeedNode, RSSFeedType FeedType) Parameters Type Name Description string FeedProperty Feed property name XmlNodeList FeedNode Feed XML node RSSFeedType FeedType Feed type Returns Type Description object | Edit this page View Source MakeArticleFromFeed(XmlNode) Generates an instance of article from feed Declaration public static RSSArticle MakeArticleFromFeed(XmlNode Article) Parameters Type Name Description XmlNode Article The child node which holds the entire article Returns Type Description RSSArticle An article | Edit this page View Source MakeRssArticlesFromFeed(XmlNodeList, RSSFeedType) Make instances of RSS Article from feed node and type Declaration public static List<RSSArticle> MakeRssArticlesFromFeed(XmlNodeList FeedNode, RSSFeedType FeedType) Parameters Type Name Description XmlNodeList FeedNode Feed XML node RSSFeedType FeedType Feed type Returns Type Description List<RSSArticle>"
2626
},
2727
"api/Syndian.html": {
2828
"href": "api/Syndian.html",
29-
"title": "Namespace Syndian | Syndian API - Aptivi Internals",
29+
"title": "Namespace Syndian | Syndian API - Aptivi",
3030
"keywords": "Namespace Syndian Classes RSSTools The RSS tools"
3131
},
3232
"index.html": {
3333
"href": "index.html",
34-
"title": "What is Syndian? | Syndian API - Aptivi Internals",
34+
"title": "What is Syndian? | Syndian API - Aptivi",
3535
"keywords": "What is Syndian? Syndian is an RSS feed library that allows you to read the articles from the specific RSS feed URL. What is this web page? This webpage is an API documentation for mod developers to be used as reference. It constantly gets updated as we push the updates to the main and servicing versions of this project. If you still intend to use a documentation specific to your preferred version of Syndian, you may refer to the releases page of the project and download the attached <version>-doc.rar file. To get started using the documentation, select API Documentation from the top menu and select a namespace to get a clear overview of the API. Feedback If you wish to leave feedback to us about this API reference website, use the issue tracker of the project. If you wish to contribute to the documentation of the API, go to the project source code and make your improvements there on a draft Pull Request; we don't support override files that are made by clicking on Improve this doc. Any meaningful contributions are welcome. Copyright (c) 2023 Aptivi. All rights reserved."
3636
}
3737
}

sitemap.xml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,43 +2,43 @@
22
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
33
<url>
44
<loc>https://aptivi.github.io/Syndian/api/Syndian.Instance.RSSArticle.html</loc>
5-
<lastmod>2023-11-26T06:45:10+00:00</lastmod>
5+
<lastmod>2023-12-04T08:15:36+00:00</lastmod>
66
<changefreq>daily</changefreq>
77
<priority>0.5</priority>
88
</url>
99
<url>
1010
<loc>https://aptivi.github.io/Syndian/api/Syndian.Instance.RSSFeed.html</loc>
11-
<lastmod>2023-11-26T06:45:10+00:00</lastmod>
11+
<lastmod>2023-12-04T08:15:36+00:00</lastmod>
1212
<changefreq>daily</changefreq>
1313
<priority>0.5</priority>
1414
</url>
1515
<url>
1616
<loc>https://aptivi.github.io/Syndian/api/Syndian.Instance.RSSFeedType.html</loc>
17-
<lastmod>2023-11-26T06:45:10+00:00</lastmod>
17+
<lastmod>2023-12-04T08:15:36+00:00</lastmod>
1818
<changefreq>daily</changefreq>
1919
<priority>0.5</priority>
2020
</url>
2121
<url>
2222
<loc>https://aptivi.github.io/Syndian/api/Syndian.Instance.html</loc>
23-
<lastmod>2023-11-26T06:45:10+00:00</lastmod>
23+
<lastmod>2023-12-04T08:15:36+00:00</lastmod>
2424
<changefreq>daily</changefreq>
2525
<priority>0.5</priority>
2626
</url>
2727
<url>
2828
<loc>https://aptivi.github.io/Syndian/api/Syndian.RSSTools.html</loc>
29-
<lastmod>2023-11-26T06:45:10+00:00</lastmod>
29+
<lastmod>2023-12-04T08:15:36+00:00</lastmod>
3030
<changefreq>daily</changefreq>
3131
<priority>0.5</priority>
3232
</url>
3333
<url>
3434
<loc>https://aptivi.github.io/Syndian/api/Syndian.html</loc>
35-
<lastmod>2023-11-26T06:45:10+00:00</lastmod>
35+
<lastmod>2023-12-04T08:15:36+00:00</lastmod>
3636
<changefreq>daily</changefreq>
3737
<priority>0.5</priority>
3838
</url>
3939
<url>
4040
<loc>https://aptivi.github.io/Syndian/index.html</loc>
41-
<lastmod>2023-11-26T06:45:10+00:00</lastmod>
41+
<lastmod>2023-12-04T08:15:36+00:00</lastmod>
4242
<changefreq>daily</changefreq>
4343
<priority>0.5</priority>
4444
</url>

0 commit comments

Comments
 (0)