ClassDoc

A component that creates a ClassDoc block for classes.

jsx

import { ClassDoc } from "@alloy-js/python";

<ClassDoc
  attributes={GoogleStyleDocAttributeProps[]}
  deprecated="string"
  description={Children[]}
  examples={Children[]}
  note="string"
  parameters={ParameterDescriptor[]}
  seeAlso={string[]}
  style={"google"}
  warning="string"
 />

stc

import { ClassDoc } from "@alloy-js/python/stc";

ClassDoc({
  attributes: GoogleStyleDocAttributeProps[],
  deprecated: string,
  description: Children[],
  examples: Children[],
  note: string,
  parameters: ParameterDescriptor[],
  seeAlso: string[],
  style: "google",
  warning: string,
}).children(children)

Props

attributes	optionalGoogleStyleDocAttributeProps[]
deprecated	optional string
description	Children[]
examples	optionalChildren[]
note	optional string
parameters	optionalParameterDescriptor[]
seeAlso	optional string[]
style	optional “google”
warning	optional string