Example Wiki

Documentation

Interface: StructuredFile

Description: Represents a structured file with a name, path, and content.

Properties

Property: name

Description: The name of the structured file.

Type:

• string

Property: path

Description: The path of the structured file.

Type:

• string

Property: content

Description: The content of the structured file.

Type:

• Content

==========

Interface: Content

Description: Represents the content of a structured file, including a description and optional items.

Properties

Property: description

Description: A textual description of the content.

Type:

• string

Property: items

Description: An optional array of items associated with the content.

Type:

• Item[] (optional)

==========

Interface: Item

Description: Represents a single item within a structured file.

Properties

Property: id

Description: A unique identifier for the item.

Type:

• string

Property: ancestors

Description: An array of strings representing the ancestors of the item in the hierarchy.

Type:

• string[]

Property: type

Description: The type of the item.

Type:

• string

Property: description

Description: A textual description of the item.

Type:

• string

Property: name

Description: The name of the item.

Type:

• string

Property: code

Description: The code associated with the item.

Type:

• string

Property: location

Description: The location of the item within the source file.

Type:

• Location

Property: item_type

Description: The type of item, for example, "function" or "variable".

Type:

• string

Property: length

Description: The length of the item.

Type:

• number

Property: params

Description: An optional array of parameters associated with the item.

Type:

• Param[] (optional)

Property: returns

Description: An optional object describing the return value of the item.

Type:

• Returns (optional)

Property: usage

Description: An optional object describing an example usage of the item.

Type:

• Usage (optional)

==========

Interface: Location

Description: Represents the location of an item within a source file.

Properties

Property: start

Description: The starting character index of the item.

Type:

• number

Property: insert

Description: The character index where the item should be inserted.

Type:

• number

Property: offset

Description: The offset of the item.

Type:

• string

Property: indent

Description: The indentation level of the item.

Type:

• number

==========

Interface: Param

Description: Represents a parameter of an item.

Properties

Property: name

Description: The name of the parameter.

Type:

• string

Property: type_name

Description: The type of the parameter.

Type:

• string

Property: description

Description: A textual description of the parameter.

Type:

• string

Property: complex_type

Description: Indicates whether the parameter has a complex type.

Type:

• boolean

==========

Interface: Returns

Description: Represents the return value of an item.

Properties

Property: type_name

Description: The type of the returned value.

Type:

• string

Property: description

Description: A textual description of the returned value.

Type:

• string

Property: complex_type

Description: Indicates whether the returned value has a complex type.

Type:

• boolean

==========

Interface: Usage

Description: Represents an example usage of an item.

Properties

Property: language

Description: The language used in the example code.

Type:

• string

Property: code

Description: The example code.

Type:

• string

Property: description

Description: A textual description of the example usage.

Type:

• string

==========