Source documentation/sv: Difference between revisions

From FreeCAD Documentation
(Updating to match new version of source page)
(Updating to match new version of source page)
Line 6: Line 6:
</div>
</div>


The online source documentation is located at the [http://www.freecadweb.org/api/ FreeCAD API website]. Please note that this documentation is not always kept to date; if you have pressing questions about the code please ask in the developer section of the [https://forum.freecadweb.org/index.php FreeCAD forum].
The documentation is hosted online at the [http://www.freecadweb.org/api/ 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 [https://forum.freecadweb.org/index.php FreeCAD forum].

Compiling the API documentation follows the same general steps as compiling the FreeCAD executable, as indicated in the [[CompileOnUnix|compile on Unix]] page.

[[File:FreeCAD_documentation_compilation_workflow.svg|800px]]

{{Caption|General workflow to compile FreeCAD's programming documentation. The Doxygen and Graphviz packages must be in the system, as well as the FreeCAD source code itself. CMake configures the system so that with a single make instruction the documentation for the the entire project is compiled into many HTML files with diagrams.}}


<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
Line 84: Line 90:
</div>
</div>


== Using Doxygen ==
== How to integrate doxygen in to the FreeCAD source code ==
{{VeryImportantMessage|This is a work in progress. See [[Doxygen]]}}


This section explains how to comment your source code so that it can be processed by Doxygen to automatically create the documentation.
See the [[Doxygen|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 {{incode|/**}} or {{incode|///}} for C++, or {{incode|##}} for Python, needs to appear before every class or function definition, so that it is picked up by Doxygen. Many [[Doxygen#Doxygen markup|special commands]], which start with {{incode|\}} or {{incode|@}}, can be used to define parts of the code and format the output. [[Doxygen#Markdown support|Markdown syntax]] is also understood within the comment block, which makes it convenient to emphasize certain parts of the documentation.
This is an example of how source code is documented. It looks into the source code of VTK, a 3D visualization library used to present multi-physics simulation results.
{{Code|code=
/**
* Returns the name of the workbench object.
*/
std::string name() const;


/**
A class to store a collection of coordinates is defined in a C++ header file. The top part of the file is commented, and a few keywords are used, like {{incode|@class}}, {{incode|@brief}}, {{incode|@sa}}, and {{incode|@par}} to indicate important parts. Inside the class, before a function is called, a block of commented text explains what the function does, and its arguments.
* Set the name to the workbench object.
*/
void setName(const std::string&);


/// remove the added TaskWatcher
*Source code of [https://github.com/Kitware/VTK/blob/master/Common/Core/vtkArrayCoordinates.h vtkArrayCoordinates.h] defining the class
void removeTaskWatcher(void);
*Doxygen produced documentation page for [http://www.vtk.org/doc/nightly/html/classvtkArrayCoordinates.html vtkArrayCoordinates class]
}}


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

Revision as of 20:49, 6 August 2019

Extra python modules
List of Commands

FreeCADs källkod är kommenterad för att tillåta automatisk generering av html dokumentation med 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 Unix page.

General workflow to compile FreeCAD's programming documentation. The Doxygen and Graphviz packages must be in the system, as well as the FreeCAD source code itself. CMake configures the system so that with a single make instruction the documentation for the the entire project is compiled into many HTML files with diagrams.

Bygga källkodsdokumentation

Om du har Doxygen installerat, så är det mycket enkelt att bygga dokumentationen. Gå till din FreeCAD byggkatalog, konfigurera din källkod med CMake, skriv

sudo apt install doxygen graphviz

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 freecad-source.
  • Create another directory freecad-build in which you will compile FreeCAD and its documentation.
  • Configure the sources with cmake, making sure you indicate the source directory, and specify the required options for your build.
  • Trigger the creation of the documentation using make.
git clone https://github.com/FreeCAD/FreeCAD.git freecad-source
mkdir freecad-build
cd freecad-build
cmake -DBUILD_QT5=ON -DPYTHON_EXECUTABLE=/usr/bin/python3 ../freecad-source

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

make -j$(nproc --ignore=2) DevDoc

och konsultera de resulterande html filerna med start i Doc/SourceDocu/html/index.html (Notera: DevDoc målet är inte giltigt för autotools byggningar)

freecad-build/doc/SourceDocu/html/

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

xdg-open freecad-build/doc/SourceDocu/html/index.html

The DevDoc 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.

make -j$(nproc --ignore=2) WebDoc

Som ett alternativ, så genereras dokumentationen då och då och finns här

FreeCAD 0.16 development documentation built by qingfeng.xia.

FreeCAD 0.19 development documentation built by qingfeng.xia.

Integrera Coin3D dokumentationen

På unix system, så är det möjligt att länka Coin3D's källk0dsdokumentation med FreeCAD's. Det innebär lättare navigering och kompletta släktträd för Coin relaterade klasser.

  • På Debian och relaterade system:
- Installera paketet libcoin60-doc
- Packa upp filen /usr/share/doc/libcoin60-doc/html/coin.tag.gz
- Generera om källkodsdokumentationen
Du är klar för offline läsning.
  • Om du inte vill eller inte kan installera Coin dokumentationspaketet, så kommer länkar att genereras för att komma åt coindokumentationen online på doc.coin3D.org, om doxygen tag filen kan laddas ned under konfigureringen (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.

/**
 * Returns the name of the workbench object.
 */
std::string name() const;

/**
 * Set the name to the workbench object.
 */
void setName(const std::string&);

/// remove the added TaskWatcher
void removeTaskWatcher(void);
Extra python modules/sv
List of Commands/sv