chore(composables): docblock pass

Author: johnleider

packages/0/src/composables/createContext/index.ts

@@ -7,12 +7,12 @@ import type { App, InjectionKey } from 'vue'
 export type ContextKey<Z> = InjectionKey<Z> | string
 
 /**
- * A simple wrapper for tapping into a v0 namespace
+ * Injects a context provided by an ancestor component.
  *
- * @param key The provided string or InjectionKey
- * @template Z The type values for the context.
- * @returns The injected context
- * @throws Error if namespace is not found.
+ * @param key The key of the context to inject.
+ * @template Z The type of the context.
+ * @returns The injected context.
+ * @throws An error if the context is not found.
  *
  * @see https://vuejs.org/api/composition-api-dependency-injection.html#inject
  * @see https://0.vuetifyjs.com/composables/foundation/create-context
@@ -28,12 +28,13 @@ export function useContext<Z> (key: ContextKey<Z>) {
 }
 
 /**
- * A simple wrapper for providing Vue context.
+ * Provides a context to all descendant components.
  *
- * @param key The provided string or InjectionKey
- * @param context The context value to provide
- * @param app Optional Vue app instance for global provide
- * @returns The provided context
+ * @param key The key of the context to provide.
+ * @param context The context to provide.
+ * @param app The Vue app instance to provide the context to.
+ * @template Z The type of the context.
+ * @returns The provided context.
  *
  * @see https://vuejs.org/api/composition-api-dependency-injection.html#provide
  * @see https://0.vuetifyjs.com/composables/foundation/create-context
@@ -45,19 +46,20 @@ export function provideContext<Z> (key: ContextKey<Z>, context: Z, app?: App) {
 }
 
 /**
- * A simple wrapper for Vues provide & inject systems
+ * Creates a new context for providing and injecting data.
  *
- * @param key The provided string or InjectionKey
- * @template Z The type values for the context.
- * @returns A tuple containing provide/inject
+ * @param _key The key of the context to create.
+ * @template Z The type of the context.
+ * @returns A tuple containing the `useContext` and `provideContext` functions.
  *
- * @see https://vuejs.org/api/composition-api-dependency-injection.html#provide
+ * @see https://vuejs.org/api/composition-api-dependency-injection.html
  * @see https://0.vuetifyjs.com/composables/foundation/create-context
  */
 export function createContext<Z> (_key: ContextKey<Z>) {
   function _provideContext (context: Z, app?: App) {
     return provideContext<Z>(_key, context, app)
   }
+
   function _useContext (key = _key) {
     return useContext<Z>(key)
   }

packages/0/src/composables/createPlugin/index.ts

@@ -12,14 +12,13 @@ export interface Plugin {
 }
 
 /**
- * A universal plugin factory to reduce boilerplate code for Vue plugin creation
+ * Creates a new Vue plugin.
  *
- * @param options Configurable object with namespace and provide/setup methods
- * @returns A Vue plugin object with install method that runs app w/ context
+ * @param options The plugin options.
+ * @returns A new Vue plugin.
  *
- * @see https://vuejs.org/guide/reusability/plugins
- * @see https://vuejs.org/api/application.html#app-runwithcontext
- * @see https://0.vuetifyjs.com/factories/create-plugin
+ * @see https://vuejs.org/guide/reusability/plugins.html
+ * @see https://0.vuetifyjs.com/composables/foundation/create-plugin
  */
 export function createPlugin<Z extends Plugin = Plugin> (options: PluginOptions) {
   return {

packages/0/src/composables/createTrinity/index.ts

@@ -8,14 +8,13 @@ export type ContextTrinity<Z = unknown> = readonly [
 ]
 
 /**
- * A tuple containing Vue's provide/inject and a context object
+ * Creates a new trinity for providing and injecting data.
  *
- * @param createContext The function that creates the context
- * @param provideContext The function that provides context
- * @param context The underlying context object singleton
- * @template Z The type parameter for the context value
- * @template E The vmodel type for the context state.
- * @returns [createContext, provideContext, context]
+ * @param createContext The function that creates the context.
+ * @param provideContext The function that provides the context.
+ * @param context The context to provide.
+ * @template Z The type of the context.
+ * @returns A new trinity.
  *
  * @see https://0.vuetifyjs.com/composables/foundation/create-trinity
  */

packages/0/src/composables/toArray/index.ts

@@ -1,7 +1,13 @@
 // Utilities
 import { isNullOrUndefined } from '#v0/utilities'
 
-/* #__NO_SIDE_EFFECTS__ */
+/**
+ * Converts a value to an array.
+ *
+ * @param value The value to convert.
+ * @template T The type of the value.
+ * @returns The converted array.
+ */
 export function toArray<T> (value: T | T[]): T[] {
   return isNullOrUndefined(value) ? [] : (Array.isArray(value) ? value : [value])
 }

packages/0/src/composables/toReactive/index.ts

@@ -5,16 +5,13 @@ import { isRef, reactive, unref } from 'vue'
 import type { MaybeRef, UnwrapNestedRefs } from 'vue'
 
 /**
- * Converts an object to a reactive reference using Vue's reactivity system.
- * This function creates a reactive version of the provided object,
- * making its properties automatically track dependencies and trigger re-renders
- * when they change.
+ * Converts a `MaybeRef` to a `UnwrapNestedRefs`.
  *
- * @param objectRef - A reference to an object that should be made reactive.
- * @template Z The type of the object that extends object.
- * @returns A reactive reference to the object.
+ * @param objectRef The object to convert.
+ * @template Z The type of the object.
+ * @returns The converted object.
  *
- * @see https://0.vuetifyjs.com/composables/transformers/to-reactive
+ * @see https://vuejs.org/api/reactivity-utilities.html#toreactive
  */
 export function toReactive<Z extends object> (
   objectRef: MaybeRef<Z>,

packages/0/src/composables/useBreakpoints/index.ts

@@ -71,12 +71,12 @@ function createDefaultBreakpoints () {
 }
 
 /**
- * Creates a reactive breakpoints system for responsive behavior management.
- * This function provides access to viewport dimensions, breakpoint detection, and helper flags
- * for determining current screen size and implementing responsive logic.
+ * Creates a new breakpoints instance.
  *
- * @param options Optional configuration for breakpoint thresholds and mobile breakpoint.
- * @returns A breakpoints context object with reactive state and utility methods.
+ * @param namespace The namespace to use for the breakpoints instance.
+ * @param options The options for the breakpoints instance.
+ * @template E The type of the breakpoints context.
+ * @returns A new breakpoints instance.
  *
  * @see https://0.vuetifyjs.com/composables/plugins/use-breakpoints
  */
@@ -207,9 +207,9 @@ export function createBreakpoints<
 }
 
 /**
- * Simple hook to access the breakpoints context.
+ * Returns the current breakpoints instance.
  *
- * @returns The breakpoints context containing current breakpoint information.
+ * @returns The current breakpoints instance.
  *
  * @see https://0.vuetifyjs.com/composables/plugins/use-breakpoints
  */
@@ -218,12 +218,11 @@ export function useBreakpoints (): BreakpointsContext {
 }
 
 /**
- * Creates a Vue plugin for managing responsive breakpoints with automatic updates.
- * This plugin sets up breakpoint tracking and updates the context when the window
- * is resized, providing reactive breakpoint state throughout the application.
+ * Creates a new breakpoints plugin.
  *
- * @param options Optional configuration for breakpoint thresholds and mobile breakpoint.
- * @returns A Vue plugin object with install method.
+ * @param options The options for the breakpoints plugin.
+ * @template E The type of the breakpoints context.
+ * @returns A new breakpoints plugin.
  *
  * @see https://0.vuetifyjs.com/composables/plugins/use-breakpoints
  */

packages/0/src/composables/useEventListener/index.ts

@@ -11,15 +11,14 @@ export type CleanupFunction = () => void
 export type EventHandler<E = Event> = (event: E) => void
 
 /**
- * Attaches event listeners to the window object with automatic cleanup.
- * This overload provides type-safe event handling for window-specific events
- * with proper event map typing and automatic listener removal on scope disposal.
+ * Attaches an event listener to the window.
  *
- * @param target Window object to attach listeners to.
- * @param event Event name(s) to listen for from WindowEventMap.
- * @param listener Event handler function(s) with proper window event typing.
- * @param options Optional event listener configuration.
- * @returns Function to manually remove all attached listeners.
+ * @param target The window object.
+ * @param event The event to listen for.
+ * @param listener The event listener.
+ * @param options The event listener options.
+ * @template E The event type.
+ * @returns A function to remove the event listener.
  *
  * @see https://0.vuetifyjs.com/composables/system/use-event-listener
  */
@@ -31,15 +30,14 @@ export function useEventListener<E extends keyof WindowEventMap> (
 ): CleanupFunction
 
 /**
- * Attaches event listeners to the document object with automatic cleanup.
- * This overload provides type-safe event handling for document-specific events
- * with proper event map typing and automatic listener removal on scope disposal.
+ * Attaches an event listener to the document.
  *
- * @param target Document object to attach listeners to.
- * @param event Event name(s) to listen for from DocumentEventMap.
- * @param listener Event handler function(s) with proper document event typing.
- * @param options Optional event listener configuration.
- * @returns Function to manually remove all attached listeners.
+ * @param target The document object.
+ * @param event The event to listen for.
+ * @param listener The event listener.
+ * @param options The event listener options.
+ * @template E The event type.
+ * @returns A function to remove the event listener.
  *
  * @see https://0.vuetifyjs.com/composables/system/use-event-listener
  */
@@ -51,15 +49,14 @@ export function useEventListener<E extends keyof DocumentEventMap> (
 ): CleanupFunction
 
 /**
- * Attaches event listeners to HTML elements with automatic cleanup.
- * This overload provides type-safe event handling for HTML element events
- * with reactive target support and automatic listener removal on scope disposal.
+ * Attaches an event listener to an HTML element.
  *
- * @param target HTML element or reactive reference to element.
- * @param event Event name(s) to listen for from HTMLElementEventMap.
- * @param listener Event handler function(s) with proper HTML element event typing.
- * @param options Optional event listener configuration.
- * @returns Function to manually remove all attached listeners.
+ * @param target The HTML element.
+ * @param event The event to listen for.
+ * @param listener The event listener.
+ * @param options The event listener options.
+ * @template E The event type.
+ * @returns A function to remove the event listener.
  *
  * @see https://0.vuetifyjs.com/composables/system/use-event-listener
  */
@@ -71,15 +68,14 @@ export function useEventListener<E extends keyof HTMLElementEventMap> (
 ): CleanupFunction
 
 /**
- * Attaches event listeners to any EventTarget with automatic cleanup.
- * This overload provides flexible event handling for any EventTarget implementation
- * with reactive target support and automatic listener removal on scope disposal.
+ * Attaches an event listener to an event target.
  *
- * @param target EventTarget or reactive reference to target.
- * @param event Event name(s) to listen for as string identifiers.
- * @param listener Event handler function(s) with customizable event typing.
- * @param options Optional event listener configuration.
- * @returns Function to manually remove all attached listeners.
+ * @param target The event target.
+ * @param event The event to listen for.
+ * @param listener The event listener.
+ * @param options The event listener options.
+ * @template EventType The event type.
+ * @returns A function to remove the event listener.
  *
  * @see https://0.vuetifyjs.com/composables/system/use-event-listener
  */
@@ -91,13 +87,13 @@ export function useEventListener<EventType = Event> (
 ): CleanupFunction
 
 /**
- * Attaches event listeners to a target with automatic cleanup.
+ * Attaches an event listener to a target.
  *
- * @param target EventTarget or reactive reference to target.
- * @param event Event name(s) to listen for as string identifiers.
- * @param listener Event handler function(s) with customizable event typing.
- * @param options Optional event listener configuration.
- * @returns Function to manually remove all attached listeners.
+ * @param target The target to attach the event listener to.
+ * @param event The event to listen for.
+ * @param listener The event listener.
+ * @param options The event listener options.
+ * @returns A function to remove the event listener.
  *
  * @see https://0.vuetifyjs.com/composables/system/use-event-listener
  */
@@ -155,14 +151,13 @@ export function useEventListener (
 }
 
 /**
- * Convenience function for attaching event listeners to the window object.
- * This function provides a simplified API by pre-binding the window target,
- * making it easier to handle window-specific events with automatic cleanup.
+ * Attaches an event listener to the window.
  *
- * @param event Event name(s) to listen for from WindowEventMap.
- * @param listener Event handler function(s) with proper window event typing.
- * @param options Optional event listener configuration.
- * @returns Function to manually remove all attached listeners.
+ * @param event The event to listen for.
+ * @param listener The event listener.
+ * @param options The event listener options.
+ * @template E The event type.
+ * @returns A function to remove the event listener.
  *
  * @see https://0.vuetifyjs.com/composables/system/use-event-listener
  */
@@ -175,14 +170,13 @@ export function useWindowEventListener<E extends keyof WindowEventMap> (
 }
 
 /**
- * Convenience function for attaching event listeners to the document object.
- * This function provides a simplified API by pre-binding the document target,
- * making it easier to handle document-specific events with automatic cleanup.
+ * Attaches an event listener to the document.
  *
- * @param event Event name(s) to listen for from DocumentEventMap.
- * @param listener Event handler function(s) with proper document event typing.
- * @param options Optional event listener configuration.
- * @returns Function to manually remove all attached listeners.
+ * @param event The event to listen for.
+ * @param listener The event listener.
+ * @param options The event listener options.
+ * @template E The event type.
+ * @returns A function to remove the event listener.
  *
  * @see https://0.vuetifyjs.com/composables/system/use-event-listener
  */

packages/0/src/composables/useFeatures/index.ts

@@ -33,13 +33,13 @@ export interface FeaturePluginOptions {
 }
 
 /**
- * Creates a feature management context with support for variations and group selection.
+ * Creates a new features instance.
  *
- * @param namespace The namespace for the feature context
- * @param options Configure initial features to register
- * @template Z The type of feature ticket
- * @template E The type of feature context
- * @returns A context trinity for the features context
+ * @param namespace The namespace to use for the features instance.
+ * @param options The options for the features instance.
+ * @template Z The type of the feature ticket.
+ * @template E The type of the feature context.
+ * @returns A new features instance.
  *
  * @see https://0.vuetifyjs.com/composables/plugins/create-features
  */
@@ -102,9 +102,10 @@ export function createFeatures<
 }
 
 /**
- * Simple hook to access the theme context.
+ * Returns the current features instance.
  *
- * @returns The features context containing current theme state and utilities.
+ * @template Z The type of the feature ticket.
+ * @returns The current features instance.
  *
  * @see https://0.vuetifyjs.com/composables/plugins/create-features
  */
@@ -113,12 +114,12 @@ export function useFeatures<Z extends FeatureTicket = FeatureTicket> (): Feature
 }
 
 /**
- * Creates a Vue plugin for feature management with variation support.
+ * Creates a new features plugin.
  *
- * @param options Configuration for initial features to register.
- * @template Z The type of feature ticket.
- * @template E The type of feature context.
- * @returns A Vue plugin object with install method.
+ * @param options The options for the features plugin.
+ * @template Z The type of the feature ticket.
+ * @template E The type of the feature context.
+ * @returns A new features plugin.
  *
  * @see https://0.vuetifyjs.com/composables/plugins/create-features
  */