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