Source documentation/ru

Исходный код FreeCAD прокомментирован для автоматической генерации html документации с помощью Doxygen.

Для тех кто хочет внимательно следить за последней svn версией FreeCAD, и кто пытается взглянуть на c++ часть кода, при первом взгляде на исходники, может создасться ощущение что ты смотришь на ежа: вы не можете отличить голову от хвоста и действительно не знаете как его поймать!

В дополнение к Wiki, документация исходников надеемся поможет облегчить это чувство, станет отправной точкой, а также позволит легко просматривать десятки файлов и каталогов.

Build source documentation
Если у вас установлен Doxygen, то собрать документацию очень просто. Отправляйтесь в каталог сборки FreeCADbuild, с конфигурируйте ваши исходники CMake, введя and consult the resulting html files starting from Doc/SourceDocu/html/index.html.

По своей природе, документация искодников есть и всегда будет в стадии разработки. Не стесняйтесь пересобирать её так часто как это необходимо. Если вы наткнетесь на вопиющие недостатки, вы можете написать об этом на форум (Примечание: Это реально полностью проверялось только в процессе сборке с помощью cMake).

Как альтернатива, документация генерируется время от времени и доступна на sourceforge здесь

Here is another FreeCAD Doxygen documentation generate by qingfeng.xia.

Объединение с документацией Coin3D
В unix системах, возможно связать документацию исходников Coin3D с FreeCAD-овской. Это упростит навигацию и закончить диаграмму наследования для производных от Coin классов.


 * В системах основанных на Debian:
 * - Установите пакет libcoin60-doc
 * - Распакуйте файл /usr/share/doc/libcoin60-doc/html/coin.tag.gz
 * - Восстановите документацию исходных кодов
 * Теперь можно читать её в оффлайне.


 * Если вы не желаете или не установили пакет документации Coin, ссылки будут сгенерированы для онлайн доступа к coin документации по адресу doc.coin3D.org, если doxygen tag файл будет загружен во время конфигурации(wget).