Lessons:13Length:1.9 hours
- Overview
- Transcript
4.1 Tomdoc Introduction
Of all three documentation tools we’re covering in the course, TomDoc is certainly the most basic one of them because it’s meant to be simple by design.
TomDoc strives for easy reading as it parses plain old English. There are no tags nor special punctuation. You just have five different sections with minimal structure so they can be parsed.
In this lesson we’ll introduce you to TomDoc, and its specification and utility tool to preview your docs in the console.
Suggested reading1.Introduction
1.1Introduction03:09
1.1
Introduction
03:09
1.2What, When, Where And Why To Document10:47
1.2
What, When, Where And Why To Document
10:47
1.3Readme Driven Development06:07
1.3
Readme Driven Development
06:07
2.RDoc
2.1RDoc Introduction and Bootstrap08:48
2.1
RDoc Introduction and Bootstrap
08:48
2.2The Rdoc Syntax10:41
2.2
The Rdoc Syntax
10:41
2.3Directives14:51
2.3
Directives
14:51
2.4Generating Documentation With Rake10:33
2.4
Generating Documentation With Rake
10:33
3.Yard
3.1Yard Introduction and Bootstrap05:44
3.1
Yard Introduction and Bootstrap
05:44
3.2Tags15:42
3.2
Tags
15:42
3.3Extended Markup08:04
3.3
Extended Markup
08:04
4.Tomdoc
4.1Tomdoc Introduction11:23
4.1
Tomdoc Introduction
11:23
4.2Integration with RDoc and Yard05:28
4.2
Integration with RDoc and Yard
05:28
5.Conclusion
5.1Final Tips04:28
5.1
Final Tips
04:28
