#tyndur · 2010-01-07
35 Nachrichten · Seite 1 von 1 · Original-CSV herunterladen
- taljethGood morning, pcmattman ;-)
- taljethHmpf, he's away again...
- pcmattmanHi taljeth
- taljethHi
- taljethAre you going to propose patches for the driver loading or is the implementation something for us others?
- pcmattmanI'm fairly busy at the moment, so I can, but it may take a while
- taljethSo you have already started working or is it just getting settled with the move?
- pcmattmanNot working yet, but there's much to do before then
- taljethSure
- taljethAnd then you mentioned documentation which didn't get many replies. Do you think doxygen is enough or should I look into setting up a wiki?
- pcmattmanI'm working on documentation localy
- pcmattman*locally
- taljethOh, you've actually started to write some? :-)
- pcmattmanYup
- pcmattmanAt the moment, it's in the form of man pages. Mainly because I can convert man pages to PDF, HTML, and various other formats very easily
- taljethOn what level do you document? The high-level overview?
- pcmattmanEach function in the interface to drivers
- pcmattmanAnd then I will also document implementing CDI in a new host operating system
- taljethOh, okay. If your documenting on a functino level, then why not extending the doxygen comments?
- pcmattmanI plan on transferring the doxygen documentation almost verbatim into the documentation
- pcmattmanThe idea is to have documentation in a non-Doxygen format that can be uploaded to a website (which people keep asking about ;) )
- taljethRight, but redundant information means soon enough outdated information
- taljethWe need to be careful with that
- taljethSo what is the real requirement? Non-Doxygen isn't a requirement per se, right?
- pcmattmanI may well end up writing a script to transfer the Doxygen documentation to a different format
- taljethYes, that could make sense
- pcmattmanAlternatively, Doxygen itself supports creating man pages, as far as I know
- taljethActually, the "script" exists and is called doxygen ;-) Maybe it's easier to use doxygen's XML output?
- taljethDoes it? I'm not sure
- pcmattmanYup, just came to a similar conclusion
- pcmattmanI'll check
- pcmattmanThere is a GENERATE_MAN Doxyfile option
- taljethAnd the result looks quite nice
- pcmattmanYup, very nice
- pcmattmanIdeally you can then run man2html on the output and get a nice, _lightweight_ (unlike Doxygen), documentation setup