gw.gosudoc.GSDocHTMLWriter.gs Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gosu-doc Show documentation

Generates Javadoc-compatible documentation for Gosu projects

There is a newer version: 1.18.2

package gw.gosudoc

uses gw.gosudoc.com.sun.tools.doclets.formats.html.HtmlDoclet
uses gw.gosudoc.doc.GSRootDocImpl

uses java.io.File
uses java.nio.charset.StandardCharsets

class GSDocHTMLWriter {

  var _inputDirs: List as InputDirs = {}
  var _output: File as Output
  var _filters: List as Filters = {}
  var _externalDocs : List as ExternalDocs = {}
  var _verbose : Boolean as Verbose

  function write(){
    // Init output directory
    Output.mkdirs()
    if( not Output.Directory ){
      throw "Destination directory must be a valid directory path"
    }
    // Create Javadoc Data Structure
    var rootDoc = new GSRootDocImpl(InputDirs, Output, Filters, ExternalDocs, Verbose)
    rootDoc.printNotice( "Generating Documentation" )
    rootDoc.genDocs()
    rootDoc.printNotice( "Finished loading types:  now generating GosuDoc HTML to: ${Output.AbsolutePath}" )

    // Generate HTML
    var doclet = new HtmlDoclet()
    doclet.configuration.charset = StandardCharsets.UTF_8.toString()
    doclet.start( rootDoc )
  }

}