Changes between Version 1 and Version 2 of Ticket #34677, comment 9
- Timestamp:
- 06/09/2016 05:50:48 PM (7 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
Ticket #34677, comment 9
v1 v2 1 1 Whew. 2 2 3 6 hours of effort yields [attachment:34677. diff], which takes the suggested inline comments and formats them into markdown tables in the DocBlock rather than placing them inline in the code. A major downside of documenting them as inline comments is that the information is only really available to somebody reading the source code.3 6 hours of effort yields [attachment:34677.2.diff], which takes the suggested inline comments and formats them into markdown tables in the DocBlock rather than placing them inline in the code. A major downside of documenting them as inline comments is that the information is only really available to somebody reading the source code. 4 4 5 5 Formatting into markdown tables has the benefit of being parseable for the Code Reference and also easily searchable from within that page. See [attachment:34677_output.2.png] for what that looks like post-parsing.