DocBox
  • Introduction
    • Release History
      • What's New With 4.1.0
      • What's New With 4.0.0
    • Contributing
  • Getting Started
    • Installation
    • Configuration
    • Annotating Your Code
  • Output Formats
    • HTML Output
    • JSON Output
      • JSON Schema
    • UML Output
    • Custom Output
Powered by GitBook
On this page

Was this helpful?

Edit on GitHub
Export as PDF
  1. Output Formats

Custom Output

In addition to the mainstream output formats, you can extend DocBox's AbstractTemplateStrategy component to generate your own custom-formatted documentation:

component extends="docbox.strategy.AbstractTemplateStrategy" accessors="true"{
   /**
    * Generate JSON documentation
    * 
    * @metadata All component metadata, sourced from DocBox.
    */
   component function run( required query metadata ){
      // generate custom documentation format from arguments.metadata
   }
}

PreviousUML Output

Last updated 4 years ago

Was this helpful?