{
  "module": "docforge.models.object",
  "content": {
    "path": "docforge.models.object",
    "docstring": "# Summary\n\nDocumentation model representing individual Python objects.\n\nThis module defines the `DocObject` class, the fundamental recursive unit of\nthe doc-forge documentation model. Each `DocObject` represents a Python\nentity such as a class, function, method, or attribute, and may contain nested\nmembers that form a hierarchical documentation structure.",
    "objects": {
      "Dict": {
        "name": "Dict",
        "kind": "alias",
        "path": "docforge.models.object.Dict",
        "signature": "<bound method Alias.signature of Alias('Dict', 'typing.Dict')>",
        "docstring": null
      },
      "Iterable": {
        "name": "Iterable",
        "kind": "alias",
        "path": "docforge.models.object.Iterable",
        "signature": "<bound method Alias.signature of Alias('Iterable', 'typing.Iterable')>",
        "docstring": null
      },
      "Optional": {
        "name": "Optional",
        "kind": "alias",
        "path": "docforge.models.object.Optional",
        "signature": "<bound method Alias.signature of Alias('Optional', 'typing.Optional')>",
        "docstring": null
      },
      "DocObject": {
        "name": "DocObject",
        "kind": "class",
        "path": "docforge.models.object.DocObject",
        "signature": "<bound method Class.signature of Class('DocObject', 15, 115)>",
        "docstring": "Representation of a documented Python object.\n\nA `DocObject` models a single Python entity discovered during\nintrospection. Objects may contain nested members, allowing the structure\nof modules, classes, and other containers to be represented recursively.\n\nAttributes:\n    name (str):\n        Local name of the object.\n\n    kind (str):\n        Type of object (for example `class`, `function`, `method`, or `attribute`).\n\n    path (str):\n        Fully qualified dotted path to the object.\n\n    signature (Optional[str]):\n        Callable signature if the object represents a callable.\n\n    docstring (Optional[str]):\n        Raw docstring text extracted from the source code.\n\n    members (Dict[str, DocObject]):\n        Mapping of member names to child `DocObject` instances.",
        "members": {
          "name": {
            "name": "name",
            "kind": "attribute",
            "path": "docforge.models.object.DocObject.name",
            "signature": null,
            "docstring": null
          },
          "kind": {
            "name": "kind",
            "kind": "attribute",
            "path": "docforge.models.object.DocObject.kind",
            "signature": null,
            "docstring": null
          },
          "path": {
            "name": "path",
            "kind": "attribute",
            "path": "docforge.models.object.DocObject.path",
            "signature": null,
            "docstring": null
          },
          "signature": {
            "name": "signature",
            "kind": "attribute",
            "path": "docforge.models.object.DocObject.signature",
            "signature": null,
            "docstring": null
          },
          "docstring": {
            "name": "docstring",
            "kind": "attribute",
            "path": "docforge.models.object.DocObject.docstring",
            "signature": null,
            "docstring": null
          },
          "members": {
            "name": "members",
            "kind": "attribute",
            "path": "docforge.models.object.DocObject.members",
            "signature": null,
            "docstring": null
          },
          "add_member": {
            "name": "add_member",
            "kind": "function",
            "path": "docforge.models.object.DocObject.add_member",
            "signature": "<bound method Function.signature of Function('add_member', 77, 87)>",
            "docstring": "Add a child documentation object.\n\nThis is typically used when attaching methods to classes or\nnested objects to their parent containers.\n\nArgs:\n    obj: Documentation object to add as a member."
          },
          "get_member": {
            "name": "get_member",
            "kind": "function",
            "path": "docforge.models.object.DocObject.get_member",
            "signature": "<bound method Function.signature of Function('get_member', 89, 105)>",
            "docstring": "Retrieve a member object by name.\n\nArgs:\n    name (str):\n        Name of the member to retrieve.\n\nReturns:\n    DocObject:\n        The corresponding `DocObject` instance.\n\nRaises:\n    KeyError:\n        If the member does not exist."
          },
          "get_all_members": {
            "name": "get_all_members",
            "kind": "function",
            "path": "docforge.models.object.DocObject.get_all_members",
            "signature": "<bound method Function.signature of Function('get_all_members', 107, 115)>",
            "docstring": "Return all child members of the object.\n\nReturns:\n    Iterable[DocObject]:\n        An iterable of `DocObject` instances representing nested members."
          }
        }
      }
    }
  }
}