Re: EuGTK 4.7.5 available
- Posted by mattlewis (admin) Dec 04, 2013
- 1828 views
Does that mean you create the html code as you type?
I am interested in the process. The o[ way is to use eudoc, creole (get html), then optionally tex (get pdf).
Why go to all that trouble when it's easier and faster to just hit some keys?
My snarky response is that it's more difficult (and slower) to "just hit some keys" and be able to generate the documentation in multiple formats. The various formats are all supported by the makefile, so it's pretty trivial to regenerate once you have your system configured. There's a lot less typing, since a lot of the boilerplate stuff is handled by the generation process, which results in improved consistency (for me, at least).
Besides I have never liked the clutter that results when all those doc strings are included In the source code.
To each his own. I find this easier, as the code and the documentation are all in one place. I'm more likely to update the documentation as I go, and more likely to notice when they get out of sync. I can also use the documentation that's right there in the code when that's more convenient than having it open in a browser or whatever.
Matt