...It's time for financial transactions...

Main menu

DoxyGen и MQL

Довольно часто бывает нужно создать документацию для некоторого количества написанного кода. Это может быть требование заказчика, или желание самого разработчика, который хотел бы сохранить для себя возможность разобраться в собственном коде через год – два.Этим целям полностью отвечает программа DoxyGen, обладающая массой положительных черт:

  • Создание документов в различных форматах, в т.ч. HtmlHlp.
  • Расширяемость
  • Гибкая настройка содержимого итоговых документов.

Логика работы с программой не сложна. Вносим нужные изменения в конфигурацию программы. Готовим исходные файлы – расставляем тэги, готовим файлы с примерами, какие то дополнительные файлы, картинки и т.д. Хотя с исходными файлами можно вообще никаких особых мероприятий не проводить. DoxyGen и по умолчанию создает вполне симпатичные CHM документы.

Изменение конфигурации DoxyGen.

В состав инсталляционного пакета входит Doxywizard.exe. Она имеет оконный интерфейс и с помощью этой программы будет выполнена настройка DoxyGen для работы с файлами MQL,

  • На вкладке Wizard заполняем имя проекта, указываем входные и выходные папки. В пункте Mode на этой же вкладки отмечаем самый первый переключатель с языком С++. Выше отмечаем “All Entities” и ставим галку на “Include cross…”. В пункте “Output” отмечаем галкой HTML и prepare for…(.chm).
  • На вкладке Expert в пункте Project следует указать язык в OUTPIT_LANGUAGE. Кодировка установлена UTF-8 и если её изменить, то все равно будет подключаться UTF-8. Другие, очень важные настройки, в соответствии со скрином:
  • Пункт Input той же вкладки меняем в соответствии со скрином:
    Нужно обратить внимание, что кодировка исходных документов указана так же UTF-8. В нашем случае она, вполне возможно, должна быть CP1251. Для задания маски файла можно применить схему, приведенную на рисунке, но можно и сокращенный вариант: *.mq*.
  • Пункт HTML той же вкладки меняем следующим образом:
    • В поле CHM_FILE указываем имя итогового файла с расширением.
    • В поле HHC_LOCATION указываем полный путь к компилятору hhc.exe.
    • В поле CHM_INDEX_ENCODING потребная кодировка файла справки.

Заключительные операции.

На этом настройка DoxyGen заканчивается. При необходимости можно кардинальным образом поменять внешний вид документации, добавить нужную информацию и различные ссылки. Этому служат специальные тэги, которые расставляются непосредственно в коде и которые понимает DoxyGen. Описание этих тэгов и всех возможностей программы имеется в документации к DoxyGen.

В заключении переходим на вкладку Run и нажимаем кнопку “Run doxygen”. Если все сделано без ошибок, то получаем нужную документацию в двух форматах:

  1. В обычном HTML
  2. В формате HtmlHlp