search

mojombo / tomdoc

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

Reorder sections to be ordered more like a class/module #29

Closed tombell closed 12 years ago

tombell commented 13 years ago

I've reordered the sections with an ordering more like the order you should read the code in, for example class/module section at the top, followed by the methods section.

Due to the reordering some of the wording in the sections may need redoing because of the new ordering, if anyone has any suggestions I'd be happy to update the changes.

mojombo commented 12 years ago

Method documentation is first on purpose, as people reading the spec for the first time will be most interested in how method docs work. This is aimed at getting people interested in TomDoc.