Skip to content

TypeDoc plugin which allows to add module-wide comments without @packageDocumentation tag

Notifications You must be signed in to change notification settings

cybersemics/typedoc-plugin-module-wide-comments

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

typedoc-plugin-module-wide-comments

Plugin

A plugin for TypeDoc

This plugin allows you to add module comments without the need to use @packageDocumentation tag.

Installation

npm install typedoc-plugin-module-wide-comments

Usage

Specify the comment at the top of your module

/**
 * Here's alert module description.
 *
 */

import { FunctionComponent } from 'react'
import { store } from '../store'

/**
 * Dispatches an alert action.
 */
const alert = (value, { showCloseLink, alertType }) => {
	...
}

export default alert

And this comment

Here's alert module description.

will be displayed at the top of generated TypeDoc module page.

About

TypeDoc plugin which allows to add module-wide comments without @packageDocumentation tag

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 100.0%