detroit-dnote - extract developers notes from ruby source code
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.
The following options can be used in the Detroit assembly file for defining a dnote service.
labels - List of labels to document. The default list includes
files - File paths to search.
exclude - Exclude paths.
ignore - Ignore paths based on any part of pathname.
title - Title to use if template can use it.
lines - Number of context lines to display.
output - Output is either a file name with a recognized extension,
a list of such file names, or a hash mapping file name to file type.
Recognized extensions include
rdoc among others.
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
For more information:
Copyright (c) 2010 Thomas Sawyer, Rubyworks
Detroit DNote is distributable in accordance with the GPLv3 license.