Package com.metaobjects.generator.direct.metadata.html

Class MetaDataHtmlDocumentationGenerator

java.lang.Object
com.metaobjects.generator.GeneratorBase
com.metaobjects.generator.direct.DirectGeneratorBase
com.metaobjects.generator.direct.metadata.html.SingleHtmlDirectGeneratorBase
com.metaobjects.generator.direct.metadata.html.MetaDataHtmlDocumentationGenerator
All Implemented Interfaces:
Generator
public class MetaDataHtmlDocumentationGenerator extends SingleHtmlDirectGeneratorBase
Professional HTML documentation generator for MetaObjects framework. Generates comprehensive, human-readable HTML documentation with: - Modern responsive design with sidebar navigation - Type hierarchy visualization with inheritance relationships - Detailed type definitions with examples and usage patterns - Plugin development guides and extension patterns - Search functionality and cross-references - Professional styling optimized for developer experience 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.html.MetaDataHtmlDocumentationGenerator</classname> <args> <outputDir>${project.build.directory}/generated-docs</outputDir> <outputFilename>metaobjects-documentation.html</outputFilename> <title>MetaObjects Framework Documentation</title> <version>6.2.0</version> <includeInheritance>true</includeInheritance> <includeExamples>true</includeExamples> <includeExtensionGuide>true</includeExtensionGuide> </args> </generator>

  • Field Details

  • Constructor Details

    • MetaDataHtmlDocumentationGenerator

      public MetaDataHtmlDocumentationGenerator()

  • Method Details

    • getWriter

      protected MetaDataHtmlDocumentationWriter getWriter(com.metaobjects.loader.MetaDataLoader loader, OutputStream os) throws GeneratorIOException
      Specified by:
      getWriter in class SingleHtmlDirectGeneratorBase
      Throws:
      GeneratorIOException

    • setVersion

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

    • setTitle

      public void setTitle(String title)
      Configure the title for the generated documentation
      Parameters:
      title - Documentation title (default: "MetaObjects Framework Documentation")

    • setIncludeInheritance

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

    • setIncludeExamples

      public void setIncludeExamples(boolean includeExamples)
      Configure whether to include usage examples for types
      Parameters:
      includeExamples - true to include usage examples (default: true)

    • setIncludeExtensionGuide

      public void setIncludeExtensionGuide(boolean includeExtensionGuide)
      Configure whether to include extension guide for plugin developers
      Parameters:
      includeExtensionGuide - true to include extension guide (default: true)

    • 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

    • registerHtmlDocAttributes

      public static void registerHtmlDocAttributes(com.metaobjects.registry.MetaDataRegistry registry)
      Registers HTML Documentation generation attributes for enhanced documentation. Can be called by plugins to add rich documentation metadata to their types.