Source documentation/ru: Difference between revisions
(Updating to match new version of source page) |
(Updating to match new version of source page) |
||
Line 1: | Line 1: | ||
<languages/> |
<languages/> |
||
{{docnav|Extra python modules|List of Commands}} |
|||
The online source documentation is located at http://www.freecadweb.org/api/ |
The online source documentation is located at http://www.freecadweb.org/api/ |
Revision as of 22:21, 29 January 2019
The online source documentation is located at http://www.freecadweb.org/api/
Исходный код FreeCAD прокомментирован для автоматической генерации html документации с помощью Doxygen.
Для тех кто хочет внимательно следить за последней svn версией FreeCAD, и кто пытается взглянуть на c++ часть кода, при первом взгляде на исходники, может создасться ощущение что ты смотришь на ежа: вы не можете отличить голову от хвоста и действительно не знаете как его поймать!
В дополнение к Wiki, документация исходников надеемся поможет облегчить это чувство, станет отправной точкой, а также позволит легко просматривать десятки файлов и каталогов.
Сборка документации исходных кодов
Если у вас установлен Doxygen, то собрать документацию очень просто. Отправляйтесь в каталог сборки FreeCADbuild, с конфигурируйте ваши исходники CMake, введя
make DevDoc
и обратитесь к получившимся html файлам, запустив Doc/SourceDocu/html/index.html (Примечание: цель DevDoc не распространяется на сборку с помощью autotools)
The DevDoc make target above will, if graphviz is installed on your system, generate a 2Gb+ volume of data. An alternative, smaller version (~500Mb), that is the version used on http://www.freecadweb.org/api/ can also be generated by issuing instead:
make WebDoc
По своей природе, документация искодников есть и всегда будет в стадии разработки. Не стесняйтесь пересобирать её так часто как это необходимо. Если вы наткнетесь на вопиющие недостатки, вы можете написать об этом на форум (Примечание: Это реально полностью проверялось только в процессе сборке с помощью 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).
How to integrate doxygen in to the FreeCAD source code
Example of a complete doxygen page: (from another project)
doxygen: http://www.vtk.org/doc/nightly/html/classvtkArrayCoordinates.html
source: https://github.com/Kitware/VTK/blob/master/Common/Core/vtkArrayCoordinates.h