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
  • Instantiate DocBox
  • Properties
  • Generate Documentation

Was this helpful?

Edit on GitHub
Export as PDF
  1. Output Formats

HTML Output

Generate browsable HTML documentation for your application CFCs

PreviousAnnotating Your CodeNextJSON Output

Last updated 4 years ago

Was this helpful?

The HTML API Strategy is used to create CFC documentation based on . DocBox does not fully support all the Javadoc syntax, but hopefully it will soon.

Instantiate DocBox

Begin by creating an instance of DocBox:

docbox = new DocBox();

Properties

The following are the properties for this strategy:

  • projectTitle : The HTML title used in the documentation

  • outputDir : The output directory absolute path

Just pass them in the docbox.addStrategy() call:

docbox = new DocBox();
docbox.addStrategy( "HTML",
  {
      projectTitle = "My Docs",
      outputDir = expandPath( "/mydocs" )  
  } );

Generate Documentation

Now that you have an instance of DocBox configured with your strategy and its properties, just execute the generate() method with its appropriate arguments:

docbox.generate(
    source  = "#expandPath( '/docbox' )",
    mapping = "coldbox",
    excludes = "tests"
);
Javadoc