Package com.metaobjects.generator.direct.metadata.ai

Class MetaDataAIDocumentationGenerator

java.lang.Object
com.metaobjects.generator.GeneratorBase
com.metaobjects.generator.direct.DirectGeneratorBase
com.metaobjects.generator.direct.metadata.json.SingleJsonDirectGeneratorBase
com.metaobjects.generator.direct.metadata.ai.MetaDataAIDocumentationGenerator
All Implemented Interfaces:
Generator
public class MetaDataAIDocumentationGenerator extends SingleJsonDirectGeneratorBase
v6.1.0: AI-optimized documentation generator for MetaData type system. Generates comprehensive documentation designed for AI consumption, including: - Inheritance hierarchy visualization - Attribute classification (inherited vs type-specific) - Extension point identification for plugin development - Complete type mapping and implementation guidance - Cross-language compatibility information This generator operates directly from the TypeDefinition registry without requiring any metadata files, making it suitable for JAR-based generation in Maven builds. Usage in Maven plugin: <generator> <classname>com.metaobjects.generator.direct.metadata.ai.MetaDataAIDocumentationGenerator</classname> <args> <outputDir>${project.build.directory}/generated-docs</outputDir> <outputFilename>metaobjects-ai-documentation.json</outputFilename> <includeInheritance>true</includeInheritance> <includeExtensionGuidance>true</includeExtensionGuidance> <includeCrossLanguageInfo>false</includeCrossLanguageInfo> </args> </generator>

  • Field Details

  • Constructor Details

    • MetaDataAIDocumentationGenerator

      public MetaDataAIDocumentationGenerator()

  • Method Details

    • getWriter

      protected JsonDirectWriter getWriter(com.metaobjects.loader.MetaDataLoader loader, OutputStream os)
      Specified by:
      getWriter in class SingleJsonDirectGeneratorBase

    • setVersion

      public void setVersion(String version)
      Configure the version string for the generated documentation
      Parameters:
      version - Version string (default: "6.1.0")

    • setIncludeInheritance

      public void setIncludeInheritance(boolean includeInheritance)
      Configure whether to include inheritance hierarchy analysis
      Parameters:
      includeInheritance - true to include inheritance visualization (default: true)

    • setIncludeImplementationDetails

      public void setIncludeImplementationDetails(boolean includeImplementationDetails)
      Configure whether to include implementation details and class mappings
      Parameters:
      includeImplementationDetails - true to include implementation mapping (default: true)

    • setIncludeExtensionGuidance

      public void setIncludeExtensionGuidance(boolean includeExtensionGuidance)
      Configure whether to include extension guidance for plugin developers
      Parameters:
      includeExtensionGuidance - true to include extension guidance (default: true)

    • setIncludeCrossLanguageInfo

      public void setIncludeCrossLanguageInfo(boolean includeCrossLanguageInfo)
      Configure whether to include cross-language implementation examples
      Parameters:
      includeCrossLanguageInfo - true to include C#/TypeScript examples (default: false)

    • toString

      public String toString()
      Overrides:
      toString in class GeneratorBase

    • getConfigurationSummary

      public String getConfigurationSummary()
      Get configuration summary for logging and debugging
      Returns:
      Human-readable configuration summary

    • registerAIDocAttributes

      public static void registerAIDocAttributes(com.metaobjects.registry.MetaDataRegistry registry)
      Registers AI Documentation generation attributes for use by the service provider pattern. Called by CodeGenMetaDataProvider to extend existing MetaData types with AI documentation-specific attributes.