Я работаю над довольно большим игровым движком RTS с открытым исходным кодом (Spring). Недавно я добавил несколько новых функций C++, которые можно вызывать с помощью Lua, и мне интересно, как их лучше документировать, и в то же время стимулировать людей к написанию/обновлению документации для множества существующих вызовов Lua. ауты
Поэтому я подумал, что было бы неплохо, если бы я мог сначала написать документацию в виде комментариев doxygen рядом с функциями C++ - это легко, потому что тело функции, очевидно, точно определяет, что делает функция. Тем не менее, я хотел бы, чтобы документация была улучшена разработчиками игр, использующими движок, которые обычно плохо понимают git (используемую нами систему контроля версий) или C++.
Следовательно, было бы идеально, если бы был способ автоматически генерировать apidocs из файла C++, а также иметь вики-подобный веб-интерфейс, позволяющий гораздо более широкой аудитории обновлять комментарии, добавлять примеры и т. д.
Итак, мне интересно, существует ли веб-инструмент, который объединяет форматирование в стиле doxygen, редактирование в стиле вики для этих комментариев (желательно, не позволяя редактировать какие-либо другие части исходного файла) и git? (для фиксации измененных комментариев через веб-интерфейс в специальную ветку)
Затем мы, разработчики, могли бы время от времени объединять эту ветку, чтобы добавлять улучшения в основную ветку, и в то же время любые улучшения документации, сделанные разработчиками, заканчивались бы в этом веб-инструменте с помощью простого слияния основной ветки в эту специальную. ответвляться.
Я еще ничего не нашел, сомневаюсь, что что-то конкретное существует, поэтому любые предложения приветствуются!
