Source documentation/pl

Przegląd
Kod źródłowy FreeCAD jest komentowany, aby umożliwić automatyczne generowanie dokumentacji programistycznej przy użyciu narzędzia Doxygen, popularnego systemu dokumentacji kodu źródłowego. Doxygen może udokumentować zarówno C++ jak i Python będącego nieodzowną częścią FreeCAD, czego wynikiem są strony HTML z hiperłączami do każdej udokumentowanej funkcji i klasy.

Dokumentacja jest przechowywana online na stronie FreeCAD API. Proszę zauważyć, że ta dokumentacja może nie zawsze być aktualna. Jeśli potrzebujesz więcej szczegółów, pobierz najnowszy kod źródłowy FreeCAD i skompiluj dokumentację samodzielnie. Jeśli masz pilne pytania dotyczące kodu, zapytaj w sekcji dla deweloperów na forum FreeCAD.

Kompilacja dokumentacji API przebiega tak samo jak kompilacja pliku wykonywalnego programu FreeCAD, jak wskazano na stronie Kompilacja w Linux OS.





Zbuduj dokumentację źródłową


Pełna dokumentacja
Jeśli masz zainstalowany Doxygen, bardzo łatwo jest zbudować dokumentację. Zainstaluj również Graphviz, aby móc tworzyć diagramy pokazujące zależności pomiędzy różnymi klasami i bibliotekami w kodzie FreeCAD. Graphviz jest również używany przez wykres zależności programu FreeCAD do pokazywania zależności pomiędzy różnymi obiektami.

Then follow the same steps you would do to compile FreeCAD, as described on the compile on Linux 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.

As mentioned in compiling (speeding up), the option sets the number of CPU cores used for compilation. The resulting documentation files will appear in the directory

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.

Reduced documentation
The complete documentation uses around 3Gb of disk space. 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.

The documentation on the FreeCAD API website is produced automatically from https://github.com/FreeCAD/SourceDoc. Anyone can rebuild it and submit a pull request:


 * Fork the repo at https://github.com/FreeCAD/SourceDoc
 * on your machine: clone the FreeCAD code (if you haven't yet), create a build dir for the doc, and clone the above SourceDoc repo inside. That SourceDoc will be updated when you rebuild the doc, and you'll be able to commit & push the results afterwards:


 * Go to your fork online, and create a pull request.

Other versions
FreeCAD 0.19 development documentation built by qingfeng.xia.

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


 * Install the, , or similarly named package.
 * Unpack the archive located in ; the files may be already unpacked in your system.
 * Generate again the source documentation.

If you don't install the documentation package for Coin, the links will be generated to access the online documentation at BitBucket. This will happen if a Doxygen tag file can be downloaded at configure time with.

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.