{
  "module": "docforge.models.module",
  "content": {
    "path": "docforge.models.module",
    "docstring": "# Summary\n\nDocumentation model representing a Python module or package.\n\nThis module defines the `Module` class used in the doc-forge documentation\nmodel. A `Module` acts as a container for top-level documented objects\n(classes, functions, variables, and other members) discovered during\nintrospection.",
    "objects": {
      "Dict": {
        "name": "Dict",
        "kind": "alias",
        "path": "docforge.models.module.Dict",
        "signature": "<bound method Alias.signature of Alias('Dict', 'typing.Dict')>",
        "docstring": null
      },
      "Iterable": {
        "name": "Iterable",
        "kind": "alias",
        "path": "docforge.models.module.Iterable",
        "signature": "<bound method Alias.signature of Alias('Iterable', 'typing.Iterable')>",
        "docstring": null
      },
      "Optional": {
        "name": "Optional",
        "kind": "alias",
        "path": "docforge.models.module.Optional",
        "signature": "<bound method Alias.signature of Alias('Optional', 'typing.Optional')>",
        "docstring": null
      },
      "DocObject": {
        "name": "DocObject",
        "kind": "class",
        "path": "docforge.models.module.DocObject",
        "signature": "<bound method Alias.signature of Alias('DocObject', 'docforge.models.object.DocObject')>",
        "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.module.DocObject.name",
            "signature": "<bound method Alias.signature of Alias('name', 'docforge.models.object.DocObject.name')>",
            "docstring": null
          },
          "kind": {
            "name": "kind",
            "kind": "attribute",
            "path": "docforge.models.module.DocObject.kind",
            "signature": "<bound method Alias.signature of Alias('kind', 'docforge.models.object.DocObject.kind')>",
            "docstring": null
          },
          "path": {
            "name": "path",
            "kind": "attribute",
            "path": "docforge.models.module.DocObject.path",
            "signature": "<bound method Alias.signature of Alias('path', 'docforge.models.object.DocObject.path')>",
            "docstring": null
          },
          "signature": {
            "name": "signature",
            "kind": "attribute",
            "path": "docforge.models.module.DocObject.signature",
            "signature": "<bound method Alias.signature of Alias('signature', 'docforge.models.object.DocObject.signature')>",
            "docstring": null
          },
          "docstring": {
            "name": "docstring",
            "kind": "attribute",
            "path": "docforge.models.module.DocObject.docstring",
            "signature": "<bound method Alias.signature of Alias('docstring', 'docforge.models.object.DocObject.docstring')>",
            "docstring": null
          },
          "members": {
            "name": "members",
            "kind": "attribute",
            "path": "docforge.models.module.DocObject.members",
            "signature": "<bound method Alias.signature of Alias('members', 'docforge.models.object.DocObject.members')>",
            "docstring": null
          },
          "add_member": {
            "name": "add_member",
            "kind": "function",
            "path": "docforge.models.module.DocObject.add_member",
            "signature": "<bound method Alias.signature of Alias('add_member', 'docforge.models.object.DocObject.add_member')>",
            "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.module.DocObject.get_member",
            "signature": "<bound method Alias.signature of Alias('get_member', 'docforge.models.object.DocObject.get_member')>",
            "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.module.DocObject.get_all_members",
            "signature": "<bound method Alias.signature of Alias('get_all_members', 'docforge.models.object.DocObject.get_all_members')>",
            "docstring": "Return all child members of the object.\n\nReturns:\n    Iterable[DocObject]:\n        An iterable of `DocObject` instances representing nested members."
          }
        }
      },
      "Module": {
        "name": "Module",
        "kind": "class",
        "path": "docforge.models.module.Module",
        "signature": "<bound method Class.signature of Class('Module', 17, 91)>",
        "docstring": "Representation of a documented Python module or package.\n\nA `Module` stores metadata about the module itself and maintains a\ncollection of top-level documentation objects discovered during\nintrospection.\n\nAttributes:\n    path (str):\n        Dotted import path of the module.\n\n    docstring (Optional[str]):\n        Module-level documentation string, if present.\n\n    members (Dict[str, DocObject]):\n        Mapping of object names to their corresponding `DocObject` representations.",
        "members": {
          "path": {
            "name": "path",
            "kind": "attribute",
            "path": "docforge.models.module.Module.path",
            "signature": null,
            "docstring": null
          },
          "docstring": {
            "name": "docstring",
            "kind": "attribute",
            "path": "docforge.models.module.Module.docstring",
            "signature": null,
            "docstring": null
          },
          "members": {
            "name": "members",
            "kind": "attribute",
            "path": "docforge.models.module.Module.members",
            "signature": null,
            "docstring": null
          },
          "add_object": {
            "name": "add_object",
            "kind": "function",
            "path": "docforge.models.module.Module.add_object",
            "signature": "<bound method Function.signature of Function('add_object', 55, 63)>",
            "docstring": "Add a documented object to the module.\n\nArgs:\n    obj (DocObject):\n        Documentation object to register as a top-level member of the module."
          },
          "get_object": {
            "name": "get_object",
            "kind": "function",
            "path": "docforge.models.module.Module.get_object",
            "signature": "<bound method Function.signature of Function('get_object', 65, 81)>",
            "docstring": "Retrieve a documented object by name.\n\nArgs:\n    name (str):\n        Name of the object to retrieve.\n\nReturns:\n    DocObject:\n        The corresponding `DocObject` instance.\n\nRaises:\n    KeyError:\n        If no object with the given name exists."
          },
          "get_all_objects": {
            "name": "get_all_objects",
            "kind": "function",
            "path": "docforge.models.module.Module.get_all_objects",
            "signature": "<bound method Function.signature of Function('get_all_objects', 83, 91)>",
            "docstring": "Return all top-level documentation objects in the module.\n\nReturns:\n    Iterable[DocObject]:\n        An iterable of `DocObject` instances representing the module's public members."
          }
        }
      }
    }
  }
}