Skip to content

LuisEGR/angularjs-ngdoc-vscode

Repository files navigation

AngularJS ngDoc - VSCode Extension

Version Version apm

apm

Generate ngDoc comments for: * Modules * Components * Controllers * Controller Functions * Directives * Filters * Services

Features

Module

Module ndDoc

  • WORKING:
    • Default ngDoc generated

Component

Component ndDoc

  • WORKING:
    • Default ngDoc generated
    • Automatic component name detection from file folder name "my-component" => "myComponent"
    • Automatic bindings name detection
    • Automatic binding type detection
  • TODO:
    • Automatic module name detection

Controller

Controller ndDoc

  • WORKING:
    • Default ngDoc generated
    • Automatic controller name detection
  • TODO:
    • Automatic function params detection
    • Anonymous arrow function (ES6)

Controller Function

Controller ndDoc

  • WORKING:
    • Default ngDoc generated
  • TODO:
    • Automatic function name detection
    • Automatic function params detection
    • Automatic function return detection

Filter

Filter ndDoc

  • WORKING
    • Default ngDoc generated
  • TODO:
    • Automatic filter name detection
    • Automatic module name detection
    • Automatic filter params detection
    • Automatic filter return detection

  • Directive Directive ndDoc
  • WORKING
    • Default ngDoc generated
    • Automatic directive name detection
    • Automatic scope detection
    • Automatic restrict detection
    • Automatic module name detection (from folder name).

Service

Service ndDoc

  • WORKING
    • Default ngDoc generated
  • TODO:
    • Automatic imports required
    • Automatic service name detection

  • Provider

Enjoy!

About

AngularJS ngDoc Generator - extension for VSCode

Resources

License

Stars

Watchers

Forks

Packages

No packages published