[doc] [план]

[Vladislav Ivanishin]

Добрый день!

Игорь Анфёров <igor-anferov at mail.ru> writes:

> Добрый день!
>
> Наша команда:
> 1. Анфёров Игорь, 
> 2. Жиганов Роман, 
> 3. Манджиев Айта,
> 4. Захаров Даниил,
> 5. Хамикоев Александр.
>
> Мы составили план работ по двум нашим проектам в рамках темы написания документации по QBE и Си-интерфейсу.
>
> Проект CompilersWiki (Захаров Даниил, Александр Хамикоев):
>
> I неделя - II неделя:
> 1. Согласование оформления документации по каждому разделу (совместно). 
> 2. Страница QBE будет содержать общее описание языка (Захаров Даниил);
> 3. Описание языка. Под этим подразумевается русификация и разбиения на отдельные
> страницы имеющейся документации c9x.me/compile/ (Захаров Даниил);
> 4. Различные проблемы, которые могут возникнуть при написании программ на языке
> QBE, либо с использованием Си библиотеки (Александр Хамикоев);
>
> III неделя (В задачах 1 - 4 каждый студент работает над своей частью кода):
> 1. (Возможно) Установка плагина DoxyWiki (https://www.mediawiki.org/wiki/Extension:DoxyWiki) (Захаров Даниил)

Нужно будет убедиться, что он работает с новыми версиями Doxygen -- я
вижу, что последний релиз был почти 10 лет назад...

> 2. Интеграция документации к коду Си-интерфейса QBE, написанной другой частью
> команды, в отдельными страницы Wiki (возможно, с помощью плагина
> DoxyWiki). (Александр Хамикоев)
> 3. Дополнение интегрированной документации (п.2) комментариями в более свободной форме (если потребуется). (Александр Хамикоев)
> 4. Примеры кода на языке QBE. (Захаров Даниил)
>
> IV неделя:
> 1. Некоторые теоретические части из лекций (будет распределено между участниками данного проекта по факту выполнения).
> 2. Составление отчета (совместно)
>
> Проект по разработке документации с помощью doxygen (Анфёров Игорь, Жиганов Роман, Манджиев Айта):
>
> I неделя:
> 1. Изучить C-интерфейс QBE

Насчёт этого пункта хочу заметить, что приоритет следует отдвать тем
частям интерфейса, которыми приходилось пользоваться во время выполнения
домашних заданий (к примеру, машинно-зависимые части all.h можно
оставить на конец и покрыть, если найдётся время). Ну и хотелось бы либо
видеть обсуждение в рассылке / коммиты в репозиторий с документацией по
ходу изучения, либо краткое неформальное описание в промежуточном отчёте
(а не просто "изучено").

> II неделя (В задачах 1 и 4 каждый студент работает над своей частью кода):
> 1. Изучить doxygen
> 2. Согласование формата документирования
> 3. Написание документации в виде комментариев к объектам в all.h

Правильно ли я понимаю, что вы хотите делать свой патч на qbe (добавить
комментарии в all.h)?

> 4. Взаимодействие с проектом Wiki по интеграции документации.
>
> III неделя:
> 1. Написание файла конфигурации для doxygen в соответствии с требованиями
> 2. Генерация html-документации с помощью doxygen
>
> IV неделя:
> 1. Составление отчёта

Надеюсь, вы не будете в самом деле целую неделю писать отчёт ;-) В любом
случае, для четвёртой недели предложить сейчас что-то осмысленное сложно.

-- 
Влад