Обсуждение вопросов связанных с doxygen.
Я начал постепенно переводить комментарии в исходном коде прошивки под doxygen. В качестве примера можно посмотреть модуль crc16. Будут замечания/пожелания как сделать лучше - предлагайте.
Для генерирования документации нужно установить doxygen. Используя командную строку, в каталоге прошивки набрать doxygen doxyconf
Пока только HTML, потом сделаю PDF (когда LaTex поставлю).
doxygen для документирования искодного кода
Moderator: STC
- STC
- LQFP144 - On Top Of The Game
- Posts: 2420
- Joined: Fri Oct 22, 2010 10:47 pm
- Location: Ukraine, Kiev
- Contact:
doxygen для документирования искодного кода
Author of the SECU-3 project. SECU-3 Engine control unit / Ignition control system
SECU-3.org (Русский)
SECU-3.org (English)
SECU-3 Club ВКонтакте
SECU-3 EMS Project Facebook
SECU-3.org (Русский)
SECU-3.org (English)
SECU-3 Club ВКонтакте
SECU-3 EMS Project Facebook
Re: doxygen для документирования искодного кода
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.
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.
DIYEFI.org - where Open Source means Open Source, and Free means Freedom
FreeEMS.org - the open source engine management system
FreeEMS dev diary and its comments thread and my turbo truck!
n00bs, do NOT PM or email tech questions! Use the forum!
The ever growing list of FreeEMS success stories!
FreeEMS.org - the open source engine management system
FreeEMS dev diary and its comments thread and my turbo truck!
n00bs, do NOT PM or email tech questions! Use the forum!
The ever growing list of FreeEMS success stories!
- STC
- LQFP144 - On Top Of The Game
- Posts: 2420
- Joined: Fri Oct 22, 2010 10:47 pm
- Location: Ukraine, Kiev
- Contact:
Re: doxygen для документирования искодного кода
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
Anyway, html is very good.
Yes, doxygen comments will be bi-lingual
Author of the SECU-3 project. SECU-3 Engine control unit / Ignition control system
SECU-3.org (Русский)
SECU-3.org (English)
SECU-3 Club ВКонтакте
SECU-3 EMS Project Facebook
SECU-3.org (Русский)
SECU-3.org (English)
SECU-3 Club ВКонтакте
SECU-3 EMS Project Facebook
- STC
- LQFP144 - On Top Of The Game
- Posts: 2420
- Joined: Fri Oct 22, 2010 10:47 pm
- Location: Ukraine, Kiev
- Contact:
Re: doxygen для документирования искодного кода
Потихоньку добавляю doxygen-комментарии к коду. Большая часть файлов прошивки уже поддерживает doxygen.
Author of the SECU-3 project. SECU-3 Engine control unit / Ignition control system
SECU-3.org (Русский)
SECU-3.org (English)
SECU-3 Club ВКонтакте
SECU-3 EMS Project Facebook
SECU-3.org (Русский)
SECU-3.org (English)
SECU-3 Club ВКонтакте
SECU-3 EMS Project Facebook