Source documentation/ru: Difference between revisions

From FreeCAD Documentation
mNo edit summary
(Updating to match new version of source page)
Line 1: Line 1:
Исходный код FreeCAD прокомментирован для автоматической генерации html документации с помощью [http://www.doxygen.org Doxygen].
FreeCAD source is commented to allow automatic html documentation generation with [http://www.doxygen.org Doxygen].


For those wanting to follow closely the latest svn versions of FreeCAD, and who try to have a look at the c++ part, the first insight in the sources can give the feeling you're looking at an hedgehog: you can't discriminate head from tail and don't really know how to catch it!
Для тех кто хочет внимательно следить за последней svn версией FreeCAD, и кто пытается взглянуть на c++ часть кода, при первом взгляде на исходники, может создасться ощущение что ты смотришь на ежа: вы не можете отличить голову от хвоста и действительно не знаете как его поймать!


In complement to the Wiki, ''source documentation'' can hopefully alleviate this feeling, providing an entry point, and allowing for easy browsing through the dozens of files and directories.
В дополнение к Wiki, ''документация исходников'' надеемся поможет облегчить это чувство, станет отправной точкой, а также позволит легко просматривать десятки файлов и каталогов.


==== Build source documentation ====
==== Сборка документации исходных кодов ====


If you have Doxygen installed, it's very easy to build the doc. Go to your FreeCAD build directory, configure your sources with CMake, issue
Если у вас установлен Doxygen, то собрать документацию очень просто. Отправляйтесь в каталог сборки FreeCADbuild, с конфигурируйте ваши исходники CMake, введя
<syntaxhighlight>
make DevDoc
make DevDoc
</syntaxhighlight>
и обратитесь к получившимся html файлам, запустив Doc/SourceDocu/html/index.html
and consult the resulting html files starting from Doc/SourceDocu/html/index.html
(Примечание: цель DevDoc не распространяется на сборку с помощью autotools)
(note: the DevDoc target is not valid for autotools builds)


By nature, source doc is, and will ever be, work in progress. Don't hesitate to rebuild as often as needed. If you fall upon blatant inadequacies, feel free to post on the forum (note: It is really fully checked with cMake build process only).
По своей природе, документация искодников есть и всегда будет в стадии разработки. Не стесняйтесь пересобирать её так часто как это необходимо. Если вы наткнетесь на вопиющие недостатки, вы можете написать об этом на форум (Примечание: Это реально полностью проверялось только в процессе сборке с помощью cMake).


Как альтернатива, документация генерируется время от времени и доступна на sourceforge [http://free-cad.sf.net/SrcDocu/index.html здесь]
As an alternative, the doc is generated from time to time and accessible on sourceforge [http://free-cad.sf.net/SrcDocu/index.html here]


==== Integrate Coin3D documentation ====
==== Объединение с документацией Coin3D ====


On unix systems, it is possible to link Coin3D source documentation with FreeCAD's.
В unix системах, возможно связать документацию исходников Coin3D с FreeCAD-овской.
It allows easier navigation and complete inheritance diagrams for Coin derived classes.
Это упростит навигацию и закончить диаграмму наследования для производных от Coin классов.


* On Debian and derived systems:
* В системах основанных на Debian:
: - Установите пакет libcoin60-doc
: - Install the package libcoin60-doc
: - Распакуйте файл /usr/share/doc/libcoin60-doc/html/coin.tag.gz
: - Uncompress the file /usr/share/doc/libcoin60-doc/html/coin.tag.gz
: - Regenerate source documentation
: - Восстановите документацию исходных кодов
: You are up for offline browsing.
: Теперь можно читать её в оффлайне.


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


{{docnav|Extra python modules/ru|List of Commands/ru}}
{{docnav|Extra python modules|List of Commands}}


[[Category:Developer Documentation]]
{{languages/ru | {{en|Source documentation}} {{es|Source documentation/es}} {{fr|Source documentation/fr}} {{it|Source documentation/it}} {{se|Source documentation/se}} }}
{{clear}}

<languages/>
[[Category:Developer Documentation/ru]]

Revision as of 18:22, 22 September 2014

FreeCAD source is commented to allow automatic html documentation generation with Doxygen.

For those wanting to follow closely the latest svn versions of FreeCAD, and who try to have a look at the c++ part, the first insight in the sources can give the feeling you're looking at an hedgehog: you can't discriminate head from tail and don't really know how to catch it!

In complement to the Wiki, source documentation can hopefully alleviate this feeling, providing an entry point, and allowing for easy browsing through the dozens of files and directories.

Build source documentation

If you have Doxygen installed, it's very easy to build the doc. Go to your FreeCAD build directory, configure your sources with CMake, issue

 make DevDoc

and consult the resulting html files starting from Doc/SourceDocu/html/index.html (note: the DevDoc target is not valid for autotools builds)

By nature, source doc is, and will ever be, work in progress. Don't hesitate to rebuild as often as needed. If you fall upon blatant inadequacies, feel free to post on the forum (note: It is really fully checked with cMake build process only).

As an alternative, the doc is generated from time to time and accessible on sourceforge here

Integrate Coin3D documentation

On unix systems, it is possible to link Coin3D source documentation with FreeCAD's. It allows easier navigation and complete inheritance diagrams for Coin derived classes.

  • On Debian and derived systems:
- Install the package libcoin60-doc
- Uncompress the file /usr/share/doc/libcoin60-doc/html/coin.tag.gz
- Regenerate source documentation
You are up for offline browsing.
  • 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).
Extra python modules
List of Commands