testbox.apidocs.docbox.strategy.api

Class HTMLAPIStrategy

lucee.Component
    extended by docbox.strategy.AbstractTemplateStrategy
      extended by testbox.apidocs.docbox.strategy.api.HTMLAPIStrategy

Default Document Strategy for DocBox
Copyright 2015 Ortus Solutions, Corp www.ortussolutions.com

Class Attributes:
  • synchronized : false
  •  
  • accessors : true
  •  
  • persistent : false
  •  
    Property Summary
    type property default serializable required
    string outputDir
          The output directory.

    • access = public
    • returntype = any
    true false
    string projectTitle
          The project title to use.

    • access = public
    • returntype = any
    Untitled true false
    Constructor Summary
    init(any outputDir, [string projectTitle='Untitled'])
          Constructor.
    Method Summary
    HTMLAPIStrategy buildClassPages(query qPackage, query qMetadata)
         builds the class pages.
    string getOutputDir()
    string getProjectTitle()
    HTMLAPIStrategy run(query qMetadata)
         Run this strategy.
    any setOutputDir(string outputDir)
    any setProjectTitle(string projectTitle)
    HTMLAPIStrategy writeAllClassesFrame(query qMetadata)
         writes the allclasses-frame.
    HTMLAPIStrategy writeOverviewSummaryAndFrame(query qMetadata)
         writes the overview-summary.
    HTMLAPIStrategy writePackagePages(query qMetadata)
         writes the package summaries.
     
    Methods inherited from class docbox.strategy.AbstractTemplateStrategy
    buildFunctionMetaData, buildPackageTree, buildPropertyMetaData, classExists, ensureDirectory, getFunctionQueryCache, getGenericTypes, getMetaSubQuery, getObjectName, getPackage, getPropertyMeta, getPropertyQueryCache, isAbstractClass, isPrimitive, resolveClassName, safeFunctionMeta, safeParamMeta, safePropertyMeta, setFunctionQueryCache, setPropertyQueryCache, typeExists, visitPackageTree, writeTemplate
     
    Methods inherited from class lucee.Component
    None

    Constructor Detail

    init

    public init(any outputDir, [string projectTitle='Untitled'])

    Constructor

    Parameters:
    outputDir - The output directory
    projectTitle - The title used in the HTML output

    Property Detail

    outputDir

    property string outputDir

    The output directory

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    projectTitle

    property string projectTitle = [Untitled]

    The project title to use

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    Method Detail

    buildClassPages

    public HTMLAPIStrategy buildClassPages(query qPackage, query qMetadata)

    builds the class pages

    Parameters:
    qPackage - the query for a specific package
    qMetadata - The metadata

    getOutputDir

    public string getOutputDir()


    getProjectTitle

    public string getProjectTitle()


    run

    public HTMLAPIStrategy run(query qMetadata)

    Run this strategy

    Overrides:
    run in class docbox.strategy.AbstractTemplateStrategy
    Parameters:
    qMetadata - The metadata

    setOutputDir

    public any setOutputDir(string outputDir)

    Parameters:
    outputDir

    setProjectTitle

    public any setProjectTitle(string projectTitle)

    Parameters:
    projectTitle

    writeAllClassesFrame

    public HTMLAPIStrategy writeAllClassesFrame(query qMetadata)

    writes the allclasses-frame.html

    Parameters:
    qMetadata - The metadata

    writeOverviewSummaryAndFrame

    public HTMLAPIStrategy writeOverviewSummaryAndFrame(query qMetadata)

    writes the overview-summary.html

    Parameters:
    qMetadata - The metadata

    writePackagePages

    public HTMLAPIStrategy writePackagePages(query qMetadata)

    writes the package summaries

    Parameters:
    qMetadata - The metadata