TomDoc. A way to write code comments that are easy to read and easy for tools to understand.

github.com/mojombo/tomdoc

Vaya's read on this project

Problem, audience, market, and the verdict — sign in to see it.

Updates

May 2012
  • Fix typo.
  • Clarify section order requirement. Closes #25.
  • Minor copy editing
October 2011
  • Merge pull request #23 from tombell/master
  • Merge pull request #26 from jc00ke/patch-1
  • You had said 5 but listed 6.
September 2011
  • Add table of contents for easier jumping to relevant sections.
  • RC1.
  • Add signature section.
June 2011
  • Merge pull request #20 from tomkersten/master
  • Use -pre instead of .pre to be semver compliant.
  • Remove extra blank line.
  • Remove redundant examples part from class section.
  • Classes and constants can be Public/Internal/Deprecated.
  • Returns/Raises.
  • Added "Public:" to attr_accessor example
  • Added "Public:" to attr_writer example
May 2011
  • Autolinking hates period suffix on link.
  • Contributing section in README should be level 2.
  • Add README.