1. detroit-dnote(5)
  2. detroit-dnote(5)

NAME

detroit-dnote - extract developers notes from ruby source code

DESCRIPTION

The DNote plug-in for Detroit utilize the DNote command line tool to extract notes from source code and construct nicely formated documentation out of it.

OPTIONS

The following options can be used in the Detroit assembly file for defining a dnote service.

EXAMPLES

The simplist entry is

dnote:
  output: NOTES.rdoc

To produce multiple formats use a list.

dnote:
  output:
    - NOTES.rdoc
    - site/notes.html

If the extension is atypical use a mapping.

 dnote:
   output:
     NOTES: markdown
     site/notes.html: html

A fuller example might look something like this.

 dnote:
   labels: [TODO, THINK, FIX]
   files: [lib, test]
   exclude:
     - lib/foo/templates
   ignore: [.yml]
   output: log/NOTES.rdoc
   lines: 5

RESOURCES

For more information:

Copyright (c) 2010 Thomas Sawyer, Rubyworks

Detroit DNote is distributable in accordance with the GPLv3 license.

SEE ALSO

dnote(1)

  1. October 2011
  2. detroit-dnote(5)