#tyndur · 2010-01-07

35 Nachrichten · Seite 1 von 1 · Original-CSV herunterladen

  1. taljethGood morning, pcmattman ;-)
  2. taljethHmpf, he's away again...
  3. pcmattmanHi taljeth
  4. taljethHi
  5. taljethAre you going to propose patches for the driver loading or is the implementation something for us others?
  6. pcmattmanI'm fairly busy at the moment, so I can, but it may take a while
  7. taljethSo you have already started working or is it just getting settled with the move?
  8. pcmattmanNot working yet, but there's much to do before then
  9. taljethSure
  10. 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?
  11. pcmattmanI'm working on documentation localy
  12. pcmattman*locally
  13. taljethOh, you've actually started to write some? :-)
  14. pcmattmanYup
  15. 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
  16. taljethOn what level do you document? The high-level overview?
  17. pcmattmanEach function in the interface to drivers
  18. pcmattmanAnd then I will also document implementing CDI in a new host operating system
  19. taljethOh, okay. If your documenting on a functino level, then why not extending the doxygen comments?
  20. pcmattmanI plan on transferring the doxygen documentation almost verbatim into the documentation
  21. pcmattmanThe idea is to have documentation in a non-Doxygen format that can be uploaded to a website (which people keep asking about ;) )
  22. taljethRight, but redundant information means soon enough outdated information
  23. taljethWe need to be careful with that
  24. taljethSo what is the real requirement? Non-Doxygen isn't a requirement per se, right?
  25. pcmattmanI may well end up writing a script to transfer the Doxygen documentation to a different format
  26. taljethYes, that could make sense
  27. pcmattmanAlternatively, Doxygen itself supports creating man pages, as far as I know
  28. taljethActually, the "script" exists and is called doxygen ;-) Maybe it's easier to use doxygen's XML output?
  29. taljethDoes it? I'm not sure
  30. pcmattmanYup, just came to a similar conclusion
  31. pcmattmanI'll check
  32. pcmattmanThere is a GENERATE_MAN Doxyfile option
  33. taljethAnd the result looks quite nice
  34. pcmattmanYup, very nice
  35. pcmattmanIdeally you can then run man2html on the output and get a nice, _lightweight_ (unlike Doxygen), documentation setup