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

Class MetaDataHtmlDocumentationWriter

java.lang.Object

com.metaobjects.io.MetaDataWriter

com.metaobjects.generator.GeneratorIOWriter<MetaDataHtmlDocumentationWriter>

com.metaobjects.generator.direct.metadata.html.MetaDataHtmlDocumentationWriter

All Implemented Interfaces:

com.metaobjects.io.MetaDataIO

public class MetaDataHtmlDocumentationWriter
extends GeneratorIOWriter<MetaDataHtmlDocumentationWriter>

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 - Plugin development guides and extension patterns - Search functionality and cross-references - Professional styling optimized for developer experience Output is a complete single-page application optimized for: - Framework understanding and adoption - Developer productivity and learning - Plugin and extension development - Cross-team collaboration and knowledge sharing

Constructor Summary

Constructors

Constructor	Description
MetaDataHtmlDocumentationWriter(com.metaobjects.loader.MetaDataLoader loader, OutputStream out)

Method Summary

Modifier and Type	Method	Description
void	close()
String	toString()
MetaDataHtmlDocumentationWriter	withExamples(boolean includeExamples)
MetaDataHtmlDocumentationWriter	withExtensionGuide(boolean includeExtensionGuide)
MetaDataHtmlDocumentationWriter	withInheritance(boolean includeInheritance)
MetaDataHtmlDocumentationWriter	withTitle(String title)
MetaDataHtmlDocumentationWriter	withVersion(String version)
void	writeHtml()

Methods inherited from class com.metaobjects.generator.GeneratorIOWriter

getFilename, getFilters, getName, getToStringOptions, withFilename, withFilters, withName

Methods inherited from class com.metaobjects.io.MetaDataWriter

getLoader, path

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

MetaDataHtmlDocumentationWriter

public MetaDataHtmlDocumentationWriter(com.metaobjects.loader.MetaDataLoader loader,
 OutputStream out)
                                throws GeneratorIOException

Throws:

GeneratorIOException

Method Details

withVersion

public MetaDataHtmlDocumentationWriter withVersion(String version)

withTitle

public MetaDataHtmlDocumentationWriter withTitle(String title)

withInheritance

public MetaDataHtmlDocumentationWriter withInheritance(boolean includeInheritance)

withExamples

public MetaDataHtmlDocumentationWriter withExamples(boolean includeExamples)

withExtensionGuide

public MetaDataHtmlDocumentationWriter withExtensionGuide(boolean includeExtensionGuide)

writeHtml

public void writeHtml()
               throws GeneratorIOException

Throws:

GeneratorIOException

close

public void close()
           throws GeneratorIOException

Specified by:

close in interface com.metaobjects.io.MetaDataIO

Specified by:

close in class GeneratorIOWriter<MetaDataHtmlDocumentationWriter>

Throws:

GeneratorIOException

toString

public String toString()

Overrides:

toString in class GeneratorIOWriter<MetaDataHtmlDocumentationWriter>