Source documentation/ru

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

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

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

Сборка документации исходных кодов
Если у вас установлен Doxygen, то собрать документацию очень просто. Отправляйтесь в каталог сборки FreeCADbuild, с конфигурируйте ваши исходники CMake, введя и обратитесь к получившимся html файлам, запустив Doc/SourceDocu/html/index.html (Примечание: цель DevDoc не распространяется на сборку с помощью autotools)

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

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

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


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


 * If you don't want to or can't install Coin doc package, the links will be generated to access coin doc online at doc.coin3D.org, if doxygen tag file can be downloaded at configure time (wget).