Source documentation/ru

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

The documentation is hosted online at the FreeCAD API website. Please note that this documentation may not always be up to date; if you need more details, download FreeCAD's latest source code and compile the documentation yourself. If you have pressing questions about the code please ask in the developer section of the FreeCAD forum.

Compiling the API documentation follows the same general steps as compiling the FreeCAD executable, as indicated in the Compile on Linux page.



Сборка документации исходных кодов
Если у вас установлен Doxygen, то собрать документацию очень просто. Отправляйтесь в каталог сборки FreeCADbuild, с конфигурируйте ваши исходники CMake, введя

Then follow the same steps you would do to compile FreeCAD, as described on the compile on Unix page, and summarized here for convenience.
 * Get the source code of FreeCAD and place it in its own directory.
 * Create another directory in which you will compile FreeCAD and its documentation.
 * Configure the sources with, making sure you indicate the source directory, and specify the required options for your build.
 * Trigger the creation of the documentation using.

While you are inside the build directory issue the following instruction to create only the documentation.

и обратитесь к получившимся html файлам, запустив Doc/SourceDocu/html/index.html (Примечание: цель DevDoc не распространяется на сборку с помощью autotools)

The point of entrance to the documentation is the file, which you can open with a web browser:

The target will generate a significant amount of data, around 5 GB of new files, particularly due to the diagrams created by Graphviz.

An alternative, smaller version of the documentation which takes only around 600 MB can be generated with a different target. This is the version displayed on the FreeCAD API website.

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

FreeCAD 0.16 development documentation built by qingfeng.xia.

FreeCAD 0.19 development documentation built 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).

Using Doxygen
See the Doxygen page for an extensive explanation on how to comment C++ and Python source code so that it can be processed by Doxygen to automatically create the documentation.

Essentially, a comment block, starting with or  for C++, or  for Python, needs to appear before every class or function definition, so that it is picked up by Doxygen. Many special commands, which start with or, can be used to define parts of the code and format the output. Markdown syntax is also understood within the comment block, which makes it convenient to emphasize certain parts of the documentation.