Page 1 of 1
doxygen для документирования искодного кода
Posted: Wed Dec 29, 2010 5:37 pm
by STC
Обсуждение вопросов связанных с doxygen.
Я начал постепенно переводить комментарии в исходном коде прошивки под doxygen. В качестве примера можно посмотреть модуль crc16. Будут замечания/пожелания как сделать лучше - предлагайте.
Для генерирования документации нужно установить doxygen. Используя командную строку, в каталоге прошивки набрать doxygen doxyconf
Пока только HTML, потом сделаю PDF (когда LaTex поставлю).
Re: doxygen для документирования искодного кода
Posted: Mon Jan 10, 2011 7:04 am
by Fred
52 reads, no replies, so I'm not feeling guilty about posting here in English :-/
OK, maybe a little... sorry!
PDF? Latex? I didn't know doxygen could do that?
I want to produce pdf docs from open office docs as part of y build process. If I could create html too, of a nice format, that would be better. Can I go from latex to OO and from latex to PDF (I know that can be done) and from latex to clean html?
Are you planning the doxygen be bi-lingual (possible?) or Russian or English?
Tell me your plans! I'm interested, even if no one else is!
Fred.
Re: doxygen для документирования искодного кода
Posted: Sun Jan 16, 2011 2:09 pm
by STC
doxygen produces html and latex. Latex can be converted to PDF. To do this you need to install latex packages. My attempts to convert latex to PDF without success (I've obtained strange errors related to unicode characters etc). So, I need to RTFM about latex and PDF conversion issues.
Anyway, html is very good.
Yes, doxygen comments will be bi-lingual
Re: doxygen для документирования искодного кода
Posted: Sat Mar 12, 2011 1:00 am
by STC
Потихоньку добавляю doxygen-комментарии к коду. Большая часть файлов прошивки уже поддерживает doxygen.