feat: add symbol documentation

Author: GabsEdits

mod.ts

@@ -2,6 +2,11 @@ import { AtomFeed } from "./src/atom.ts";
 import { RssFeed } from "./src/rss.ts";
 import { JsonFeed } from "./src/json.ts";
 
+/** Atom feed export */
 export const Atom = AtomFeed;
+
+/** RSS feed export */
 export const Rss = RssFeed;
+
+/** JSON feed export */
 export const Json = JsonFeed;

src/atom.ts

@@ -13,11 +13,20 @@ interface AtomEntry {
   };
 }
 
+/** Class representing an Atom feed. */
 export class AtomFeed extends BaseFeed<AtomEntry> {
+  /**
+   * Create an AtomFeed.
+   * @param {FeedOptions} options - The feed options.
+   */
   constructor(options: FeedOptions) {
     super(options);
   }
 
+  /**
+   * Build the Atom feed XML string.
+   * @returns {string} The XML string of the Atom feed.
+   */
   build(): string {
     const xmlParts: string[] = [
       `<?xml version="1.0" encoding="UTF-8"?>\n`,

src/common.ts

@@ -1,3 +1,6 @@
+/**
+ * Interface representing the options for a feed.
+ */
 export interface FeedOptions {
   title: string;
   description: string;
@@ -19,6 +22,11 @@ export interface FeedOptions {
   icon?: string;
 }
 
+/**
+ * Escapes special characters in a string to their corresponding XML entities.
+ * @param unsafe - The string to be escaped.
+ * @returns The escaped string.
+ */
 export function escapeXml(unsafe: string): string {
   const escapeMap: { [key: string]: string } = {
     "<": "&lt;",
@@ -30,11 +38,19 @@ export function escapeXml(unsafe: string): string {
   return unsafe.replace(/[<>&'"]/g, (c) => escapeMap[c] || c);
 }
 
+/**
+ * Abstract class representing a base feed.
+ * @template T - The type of items in the feed.
+ */
 export abstract class BaseFeed<T> {
   protected options: FeedOptions;
   protected items: Array<T>;
   protected categories: Set<string>;
 
+  /**
+   * Creates an instance of BaseFeed.
+   * @param options - The options for the feed.
+   */
   constructor(options: FeedOptions) {
     this.options = {
       ...options,
@@ -44,16 +60,32 @@ export abstract class BaseFeed<T> {
     this.categories = new Set();
   }
 
+  /**
+   * Builds the feed and returns it as a string.
+   * @returns The feed as a string.
+   */
   abstract build(): string;
 
+  /**
+   * Adds an item to the feed.
+   * @param item - The item to be added.
+   */
   addItem(item: T) {
     this.items.push(item);
   }
 
+  /**
+   * Adds a category to the feed.
+   * @param category - The category to be added.
+   */
   addCategory(category: string) {
     this.categories.add(category);
   }
 
+  /**
+   * Adds a contributor to the feed.
+   * @param contributor - The contributor to be added.
+   */
   addContributor(contributor: { name: string; email: string; link?: string }) {
     this.options.authors.push(contributor);
   }

src/json.ts

@@ -8,11 +8,20 @@ interface JsonItem {
   url: string;
 }
 
+/** This class represents a JSON Feed and provides methods to build the feed. */
 export class JsonFeed extends BaseFeed<JsonItem> {
+  /**
+   * Constructs a new JsonFeed instance.
+   * @param options - The options for the feed.
+   */
   constructor(options: FeedOptions) {
     super(options);
   }
 
+  /**
+   * Builds the JSON feed and returns it as a string.
+   * @returns The JSON feed as a string.
+   */
   build(): string {
     const json: Record<string, unknown> = {
       version: "https://jsonfeed.org/version/1",

src/rss.ts

@@ -12,11 +12,20 @@ interface RssItem {
   };
 }
 
+/** Class representing an RSS feed. */
 export class RssFeed extends BaseFeed<RssItem> {
+  /**
+   * Create an RSS feed.
+   * @param {FeedOptions} options - The options for the feed.
+   */
   constructor(options: FeedOptions) {
     super(options);
   }
 
+  /**
+   * Build the RSS feed XML string.
+   * @returns {string} The RSS feed as an XML string.
+   */
   build(): string {
     const xmlParts: string[] = [
       `<?xml version="1.0" encoding="UTF-8"?>\n`,