Skip to content

OpenEdge automated documentation generation based on JSDuck

License

Notifications You must be signed in to change notification settings

spazzymoto/ablduck

Repository files navigation

AblDuck Template

GitHub Actions

Description

Generates documentation from OpenEdge classes & procedures. ABLDuck is based of the JSDuck documentation tool for JavaScript.

Features

  • JavaDoc style comments
  • ABLDoc style comments
  • Markdown support
  • Globally seachable on class name, method name, property name, event name, procedure name and function name
  • Syntax highlighted code examples in the comment
  • Tag support: {@link}, @author, @internal, @deprecated, @param and @return
  • View class menu by package or inheritance
  • Automatic linking of known datatypes

See a live Example. Be sure to use the "show" drop down on the right of the screen to filter public/protected/private/inherited/deprecated/internal members.

Build

  • Install Sencha CMD 4 (Installers can be found in SenchaCMDInstallers)
  • From the root directory execute "sencha app build"
  • Build can be found in build/production

Usage

Please see the ABLDuck task documentation in the PCT tool for more information. This is just the repository for the template.

screenshot

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •