📚 docs: add jsdoc for type of each part of speech

.vscode/settings.json

@@ -64,6 +64,7 @@
     "rima",
     "rimum",
     "rimus",
+    "sapienter",
     "sapientis",
     "sapientius",
     "scribere",

adjectives/index.ts

@@ -11,6 +11,13 @@ const Options = z.object({
   overrides: Overrides
 }).default({});
 
+/** The type for a declined adjective. This can be passed to {@link scriptor} for better intellisense.
+ * 
+ * @example
+ * ```ts
+ * const declined = scriptor<Adjective>("sapiens, sapientis");
+ * ```
+ */
 type AdjectiveOptions = {
   overrides?: AdjectiveShape
 } | undefined;

adverbs/index.ts

@@ -11,6 +11,13 @@ const Options = z.object({
   overrides: Overrides
 }).default({});
 
+/** The type for the forms of an adverb. This can be passed to {@link scriptor} for better intellisense.
+ * 
+ * @example
+ * ```ts
+ * const forms = scriptor<Adverb>("sapienter");
+ * ```
+ */
 type AdverbOptions = {
   overrides?: AdverbShape
 } | undefined;

nouns/index.ts

@@ -20,6 +20,13 @@ const Options = z.object({
   overrides: Overrides
 }).default({});
 
+/** The type for a declined noun. This can be passed to {@link scriptor} for better intellisense.
+ * 
+ * @example
+ * ```ts
+ * const declined = scriptor<Noun>("scriptor, scriptoris, m");
+ * ```
+ */
 type NounOptions = {
   iStem?: boolean,
   overrides?: NounShape

verbs/index.ts

@@ -11,6 +11,13 @@ const Options = z.object({
   overrides: Overrides
 }).default({});
 
+/** The type for a conjugated verb. This can be passed to {@link scriptor} for better intellisense.
+ * 
+ * @example
+ * ```ts
+ * const conjugated = scriptor<Verb>("scribo, scribere, scripsi, scriptus");
+ * ```
+ */
 type VerbOptions = {
   overrides?: VerbShape
 } | undefined;