add comments for functions

Author: tlabaj

packages/react-icons/src/createIcon.tsx

@@ -51,6 +51,7 @@ export interface SVGIconProps extends Omit<React.HTMLProps<SVGElement>, 'ref'> {
 
 let currentId = 0;
 
+/** Returns path data from `svgPathData` or deprecated `svgPath` (prefers `svgPathData` when both exist). */
 function resolveSvgPathData(icon: IconDefinition): string | SVGPathObject[] {
   if ('svgPathData' in icon && icon.svgPathData !== undefined) {
     return icon.svgPathData;
@@ -61,6 +62,7 @@ function resolveSvgPathData(icon: IconDefinition): string | SVGPathObject[] {
   throw new Error('@patternfly/react-icons: IconDefinition must define svgPathData or svgPath');
 }
 
+/** Produces a single {@link IconDefinitionWithSvgPathData} for internal rendering. */
 function normalizeIconDefinition(icon: IconDefinition): IconDefinitionWithSvgPathData {
   return {
     name: icon.name,
@@ -73,6 +75,7 @@ function normalizeIconDefinition(icon: IconDefinition): IconDefinitionWithSvgPat
   };
 }
 
+/** True when the argument uses the nested `CreateIconProps` shape (`icon` and/or `rhUiIcon` keys). */
 function isNestedCreateIconProps(arg: object): arg is CreateIconProps {
   return 'icon' in arg || 'rhUiIcon' in arg;
 }
@@ -84,6 +87,10 @@ interface NormalizedCreateIconProps {
   rhUiIcon: IconDefinitionWithSvgPathData | null;
 }
 
+/**
+ * Coerces legacy flat or nested props into normalized {@link NormalizedCreateIconProps}.
+ * Nested input must include a non-null `icon` or throws.
+ */
 function normalizeCreateIconArg(arg: CreateIconProps | LegacyFlatIconDefinition): NormalizedCreateIconProps {
   if (isNestedCreateIconProps(arg)) {
     const p = arg as CreateIconProps;
@@ -106,6 +113,7 @@ function normalizeCreateIconArg(arg: CreateIconProps | LegacyFlatIconDefinition)
   };
 }
 
+/** Renders an inner `<svg>` with viewBox and path(s) for the dual-SVG (CSS swap) layout. */
 const createSvg = (icon: IconDefinitionWithSvgPathData, iconClassName: string) => {
   const { xOffset, yOffset, width, height, svgPathData, svgClassName } = icon ?? {};
   const _xOffset = xOffset ?? 0;
@@ -170,6 +178,7 @@ export function createIcon(arg: CreateIconProps | LegacyFlatIconDefinition): Rea
 
     id = `icon-title-${currentId++}`;
 
+    /** Renders one root `<svg>`; either a single variant or nested inner SVGs for RH UI swap. */
     render() {
       const { title, className: propsClassName, set, ...props } = this.props;