If you could write this kind of documentaton in a YARDish format (there are lots of examples lately from @jlee-r7) that would be way more useful for autogenerating documentation.