Upgrade package version.

Add documentation.
CXuesong · Aug 12, 2018 · b196d56 · b196d56
1 parent b1e0abe
commit b196d56
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 5 deletions.
diff --git a/WikiClientLibrary/Generators/AllPagesGenerator.cs b/WikiClientLibrary/Generators/AllPagesGenerator.cs
@@ -15,6 +15,11 @@ namespace WikiClientLibrary.Generators
     /// <summary>
     /// Generates all the pages in a specific namespace.
     /// </summary>
+    /// <remarks>
+    /// To enumerate all the categories used on a wiki site,
+    /// along with those without existing category pages, use <see cref="CategoriesGenerator"/>.
+    /// </remarks>
+    /// <seealso cref="RandomPageGenerator"/>
     public class AllPagesGenerator : WikiPageGenerator
     {
 
@@ -23,7 +28,10 @@ public AllPagesGenerator(WikiSite site) : base(site)
         {
         }
 
-        public int NamespaceId { get; set; } = 0;
+        /// <summary>
+        /// List all the pages in this namespace.
+        /// </summary>
+        public int NamespaceId { get; set; } = BuiltInNamespaces.Main;
 
         /// <summary>
         /// Start listing at this title. The title need not exist.

diff --git a/WikiClientLibrary/Generators/RecentChangesGenerator.cs b/WikiClientLibrary/Generators/RecentChangesGenerator.cs
@@ -70,10 +70,19 @@ public RecentChangesGenerator(WikiSite site) : base(site)
         /// </summary>
         public RecentChangesFilterTypes TypeFilters { get; set; } = RecentChangesFilterTypes.All;
 
+        /// <summary>
+        /// Whether to list minor edits.
+        /// </summary>
         public PropertyFilterOption MinorFilter { get; set; }
 
+        /// <summary>
+        /// Whether to list bot edits.
+        /// </summary>
         public PropertyFilterOption BotFilter { get; set; }
 
+        /// <summary>
+        /// Whether to list edits by anonymous users.
+        /// </summary>
         public PropertyFilterOption AnonymousFilter { get; set; }
 
         /// <summary>
@@ -158,6 +167,7 @@ public override IEnumerable<KeyValuePair<string, object>> EnumGeneratorParameter
         // if a wiki page is modified more than once. And when a page title is shown for the
         // 2nd, 3rd, etc time, only the properties that has been changed will be included in JSON,
         // which will screw up Page.LoadFromJson .
+        /// <inheritdoc />
         protected override bool DistinctGeneratedPages => true;
 
         /// <inheritdoc />

diff --git a/WikiClientLibrary/Generators/WikiPageExtensions.cs b/WikiClientLibrary/Generators/WikiPageExtensions.cs
@@ -11,18 +11,33 @@ namespace WikiClientLibrary.Generators
     public static class WikiPageExtensions
     {
 
+        /// <summary>
+        /// Creates a <see cref="LinksGenerator"/> instance from the specified page,
+        /// which generates pages from all links on the page.
+        /// </summary>
+        /// <param name="page">The page.</param>
         public static LinksGenerator CreateLinksGenerator(this WikiPage page)
         {
             if (page == null) throw new ArgumentNullException(nameof(page));
             return new LinksGenerator(page.Site, page.Title);
         }
 
+        /// <summary>
+        /// Creates a <see cref="TransclusionsGenerator"/> instance from the specified page,
+        /// which generates pages from all pages (typically templates) transcluded in the page.
+        /// </summary>
+        /// <param name="page">The page.</param>
         public static TransclusionsGenerator CreateTransclusionsGenerator(this WikiPage page)
         {
             if (page == null) throw new ArgumentNullException(nameof(page));
             return new TransclusionsGenerator(page.Site, page.Title);
         }
 
+        /// <summary>
+        /// Creates a <see cref="RevisionsGenerator"/> instance from the specified page,
+        /// which enumerates the sequence of revisions on the page.
+        /// </summary>
+        /// <param name="page">The page.</param>
         public static RevisionsGenerator CreateRevisionsGenerator(this WikiPage page)
         {
             if (page == null) throw new ArgumentNullException(nameof(page));

diff --git a/WikiClientLibrary/WikiClientLibrary.csproj b/WikiClientLibrary/WikiClientLibrary.csproj
@@ -4,9 +4,9 @@
     <TargetFrameworks>netstandard1.1;netstandard2.0</TargetFrameworks>
     <AssemblyName>WikiClientLibrary</AssemblyName>
     <PackageId>CXuesong.MW.WikiClientLibrary</PackageId>
-    <Version>0.6.0</Version>
-    <AssemblyVersion>0.6.0.18</AssemblyVersion>
-    <FileVersion>0.6.0.18</FileVersion>
+    <Version>0.6.1</Version>
+    <AssemblyVersion>0.6.1.0</AssemblyVersion>
+    <FileVersion>0.6.1.0</FileVersion>
     <Copyright>Copyright (C) CXuesong 2018</Copyright>
     <Description>
       Wiki Client Library is a .NET Standard &amp; asynchronous client library for MediaWiki sites.
@@ -33,7 +33,7 @@
     <GenerateDocumentationFile>True</GenerateDocumentationFile>
     <Authors>CXuesong</Authors>
     <Company />
-    <NoWarn>1701;1702;1705;1573；1591</NoWarn>
+    <NoWarn>1701;1702;1705;1573;1591</NoWarn>
     <SignAssembly>true</SignAssembly>
     <AssemblyOriginatorKeyFile>../WikiClientLibrary.snk</AssemblyOriginatorKeyFile>
     <PublishRepositoryUrl>True</PublishRepositoryUrl>