search

mojombo / tomdoc

A flexible code documentation specification with human readers in mind.
333 stars 47 forks source link

Custom Heuristics #11

Closed trans closed 13 years ago

trans commented 14 years ago

I recently developed a program for generating pretty changelogs (see vclog). To do this I needed to let developers classify commit messages. But there is no standard means of doing this. So I created a heuristics system which the end user can customize, where each rule takes in the commit message and spits out the classification the commit belongs too.

I was thinking that kind of design might be a good fit for tomdoc too. The specification would represent the default set of heuristics. But developers could write their own rules for parsing out the various types of information tomdoc recognizes (arguments, return values, etc).

trans commented 13 years ago

Closing this b/c I realize now it doesn't directly pertain to TomDoc.