UIZE JavaScript Framework

MODULES Uize.Doc.Sucker

1. Introduction

The Uize.Doc.Sucker package provides methods for extracting SimpleDoc documentation from special documentation comments inside JavaScript source code.

DEVELOPERS: Chris van Rensburg

1.1. Examples

There are no dedicated showcase example pages for the Uize.Doc.Sucker module.

SEARCH FOR EXAMPLES

Use the link below to search for example pages on the UIZE Web site that reference the Uize.Doc.Sucker module...

SEARCH

1.2. Implementation Info

The Uize.Doc.Sucker module defines the Uize.Doc.Sucker package under the Uize.Doc namespace.

1.2.1. Features Introduced in This Module

The features listed in this section have been introduced in this module.

STATIC METHODS

Uize.Doc.Sucker.suckDoc | Uize.Doc.Sucker.toDocument

STATIC PROPERTIES

Uize.Doc.Sucker.moduleName | Uize.Doc.Sucker.pathToResources

1.2.2. Features Overridden in This Module

No features have been overridden in this module.

1.2.3. Features Inherited From Other Modules

This module has no inherited features.

1.2.4. Modules Directly Under This Namespace

There are no modules directly under this namespace.

1.2.5. Unit Tests

There is no dedicated unit tests module for the Uize.Doc.Sucker module.

2. Static Methods

2.1. Uize.Doc.Sucker.suckDoc

IMPLEMENTATION INFO

this feature was introduced in this module

2.2. Uize.Doc.Sucker.toDocument

IMPLEMENTATION INFO

this feature was introduced in this module

3. Static Properties

3.1. Uize.Doc.Sucker.moduleName

IMPLEMENTATION INFO

this feature was introduced in this module

3.2. Uize.Doc.Sucker.pathToResources

IMPLEMENTATION INFO

this feature was introduced in this module