Source documentation/ja: Difference between revisions
(Updating to match new version of source page) |
(Updating to match new version of source page) |
||
Line 41: | Line 41: | ||
</div> |
</div> |
||
The point of entrance to the documentation is the {{incode|index.html}} file, which you can open with |
The point of entrance to the documentation is the {{incode|index.html}} file, which you can open with a web browser: |
||
{{Code|code= |
{{Code|code= |
||
xdg-open freecad-build/doc/SourceDocu/html/index.html |
xdg-open freecad-build/doc/SourceDocu/html/index.html |
||
Line 51: | Line 51: | ||
</div> |
</div> |
||
An alternative, smaller version of the documentation which takes only around |
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 [http://www.freecadweb.org/api/ FreeCAD API website]. |
||
{{Code|code= |
{{Code|code= |
||
make -j$(nproc --ignore=2) WebDoc |
make -j$(nproc --ignore=2) WebDoc |
||
Line 89: | Line 89: | ||
== How to integrate doxygen in to the FreeCAD source code == |
== How to integrate doxygen in to the FreeCAD source code == |
||
{{VeryImportantMessage|This is a |
{{VeryImportantMessage|This is a work in progress. See [[Doxygen]]}} |
||
Example of a complete doxygen page: (from another project) |
|||
This section explains how to comment your source code so that it can be processed by Doxygen to automatically create the documentation. |
|||
doxygen: http://www.vtk.org/doc/nightly/html/classvtkArrayCoordinates.html |
|||
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. |
|||
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. |
|||
<div class="mw-translate-fuzzy"> |
|||
source: https://github.com/Kitware/VTK/blob/master/Common/Core/vtkArrayCoordinates.h |
source: https://github.com/Kitware/VTK/blob/master/Common/Core/vtkArrayCoordinates.h |
||
</div> |
|||
{{docnav|Extra python modules|List of Commands}} |
{{docnav|Extra python modules|List of Commands}} |
Revision as of 10:38, 14 July 2019
FreeCADのソースコードは、Doxygenを使ってHTMLドキュメントを自動生成するようにコメントされています。これは、FreeCADソースコードのC ++部分とPython部分の両方に当てはまります。
オンラインのソースドキュメントはhttp://www.freecadweb.org/api/にあります。
ソースドキュメントのビルド
Doxygenをインストールしてあればドキュメントのビルドは非常に簡単です。FreeCADビルド用のディレクトリに移動してCMakeでソースを設定した上で次のコマンドを実行します:
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
その後でDoc/SourceDocu/html/index.htmlから始まる結果の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
(注意:DevDocターゲットは自動ツールビルドでは有効になっていません)その性質上、ソースドキュメントは常に作業進行中状態にあります。よく起きることですが必要がある時にはためらわずに再ビルドを行なってください。 それはhttp://www.freecadweb.org/api/で使用されているバージョンも代わりに発行することによって生成することができます:
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
またこれとは別にこのドキュメントは折を見て生成されては、sourceforgeのここでアクセス可能な状態で置かれています。
FreeCAD 0.16 development documentation built by qingfeng.xia.
これはFreeCAD Doxygen documentationです qingfeng.xiaによって生成されます。
Coin3Dドキュメントの統合
UNIX系ではCoin3DのソースドキュメントをFreeCADのものとリンクすることが可能です。 これを行うと移動が楽になり、またCoin派生クラスの継承ダイアグラムを作成できます。
- Debianとそこから派生したシステムの場合:
- - パッケージlibcoin60-docをインストール
- - ファイル /usr/share/doc/libcoin60-doc/html/coin.tag.gzを展開
- - ソースドキュメントを再生成
- オフラインでのブラウジングができます。
- もしCoinのドキュメントパッケージをインストールしたくない/できない場合、設定時(wget)にDoxygenタグファイルがダウンロード可能であればdoc.coin3D.orgにあるオンラインのCoinドキュメントへのリンクが生成されます。
How to integrate doxygen in to the FreeCAD source code
This section explains how to comment your source code so that it can be processed by Doxygen to automatically create 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.
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 @class
, @brief
, @sa
, and @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.
- Getting started
- Installation: Download, Windows, Linux, Mac, Additional components, Docker, AppImage, Ubuntu Snap
- Basics: About FreeCAD, Interface, Mouse navigation, Selection methods, Object name, Preferences, Workbenches, Document structure, Properties, Help FreeCAD, Donate
- Help: Tutorials, Video tutorials
- Workbenches: Std Base, Arch, Assembly, CAM, Draft, FEM, Inspection, Mesh, OpenSCAD, Part, PartDesign, Points, Reverse Engineering, Robot, Sketcher, Spreadsheet, Start, Surface, TechDraw, Test Framework, Web
- Hubs: User hub, Power users hub, Developer hub