Source documentation/ja: Difference between revisions
(Updating to match new version of source page) |
(Updating to match new version of source page) |
||
Line 2: | Line 2: | ||
{{docnav|Extra python modules|List of Commands}} |
{{docnav|Extra python modules|List of Commands}} |
||
<div class="mw-translate-fuzzy"> |
|||
⚫ | |||
FreeCADのソースコードは、[http://www.doxygen.org Doxygen]を使ってHTMLドキュメントを自動生成するようにコメントされています。これは、FreeCADソースコードのC ++部分とPython部分の両方に当てはまります。 |
FreeCADのソースコードは、[http://www.doxygen.org Doxygen]を使ってHTMLドキュメントを自動生成するようにコメントされています。これは、FreeCADソースコードのC ++部分とPython部分の両方に当てはまります。 |
||
</div> |
|||
<div class="mw-translate-fuzzy"> |
|||
FreeCADの最新のSVN版を追従したい人、そしてC ++やPythonの部分を読むことに挑戦する人がソースを読んでまず思うのはまるで強固な要塞でも見ているようだ、ということでしょう。どこから始まってどこで終わっているのか見当もつかないし、どこから手をつけたらいいかもわからないでしょう! |
|||
⚫ | |||
</div> |
|||
Wikiに加えて''ソースドキュメント''[http://www.freecadweb.org/api/ Source Documentation]を読むことでその感覚が緩和され、取っ掛かりを見つけて、数十ものファイルやディレクトリを簡単に見通せる様になることを願っています。 |
|||
<div class="mw-translate-fuzzy"> |
|||
==== ソースドキュメントのビルド ==== |
==== ソースドキュメントのビルド ==== |
||
</div> |
|||
<div class="mw-translate-fuzzy"> |
|||
Doxygenをインストールしてあればドキュメントのビルドは非常に簡単です。FreeCADビルド用のディレクトリに移動してCMakeでソースを設定した上で次のコマンドを実行します: |
Doxygenをインストールしてあればドキュメントのビルドは非常に簡単です。FreeCADビルド用のディレクトリに移動してCMakeでソースを設定した上で次のコマンドを実行します: |
||
</div> |
|||
{{Code|code= |
{{Code|code= |
||
sudo apt install doxygen graphviz |
|||
make DevDoc |
|||
}} |
}} |
||
Then follow the same steps you would do to compile FreeCAD, as described on the [[CompileOnUnix|compile on Unix]] page, and summarized here for convenience. |
|||
* Get the source code of FreeCAD and place it in its own directory {{incode|freecad-source}}. |
|||
* Create another directory {{incode|freecad-build}} in which you will compile FreeCAD and its documentation. |
|||
* Configure the sources with {{incode|cmake}}, making sure you indicate the source directory, and specify the required options for your build. |
|||
* Trigger the creation of the documentation using {{incode|make}}. |
|||
{{Code|code= |
|||
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. |
|||
{{Code|code= |
|||
make -j$(nproc --ignore=2) DevDoc |
|||
}} |
|||
<div class="mw-translate-fuzzy"> |
|||
その後でDoc/SourceDocu/html/index.htmlから始まる結果のhtmlファイルを調べてください。 |
その後でDoc/SourceDocu/html/index.htmlから始まる結果のhtmlファイルを調べてください。 |
||
</div> |
|||
The point of entrance to the documentation is the {{incode|index.html}} file, which you can open with your web browser: |
|||
{{Code|code= |
|||
xdg-open freecad-build/doc/SourceDocu/html/index.html |
|||
}} |
|||
<div class="mw-translate-fuzzy"> |
|||
(注意:DevDocターゲットは自動ツールビルドでは有効になっていません)その性質上、ソースドキュメントは常に作業進行中状態にあります。よく起きることですが必要がある時にはためらわずに再ビルドを行なってください。 |
(注意:DevDocターゲットは自動ツールビルドでは有効になっていません)その性質上、ソースドキュメントは常に作業進行中状態にあります。よく起きることですが必要がある時にはためらわずに再ビルドを行なってください。 |
||
それはhttp://www.freecadweb.org/api/で使用されているバージョンも代わりに発行することによって生成することができます: |
それはhttp://www.freecadweb.org/api/で使用されているバージョンも代わりに発行することによって生成することができます: |
||
</div> |
|||
An alternative, smaller version of the documentation which takes only around 500 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 WebDoc |
make -j$(nproc --ignore=2) WebDoc |
||
}} |
}} |
||
<div class="mw-translate-fuzzy"> |
|||
元のドキュメントは元々進行中の作業であり、今後もそうなる予定です。必要に応じて頻繁に再構築することを躊躇しないでください。もし明らかな不備を見つけた場合には遠慮無くフォーラムに投稿してください(注意:CMakeビルドプロセスでしか全体のチェックは行われていません)。 |
|||
またこれとは別にこのドキュメントは折を見て生成されては、sourceforgeの[http://free-cad.sf.net/SrcDocu/index.html ここ]でアクセス可能な状態で置かれています。 |
またこれとは別にこのドキュメントは折を見て生成されては、sourceforgeの[http://free-cad.sf.net/SrcDocu/index.html ここ]でアクセス可能な状態で置かれています。 |
||
</div> |
|||
[https://iesensor.com/FreeCADDoc/0.16-dev/ FreeCAD 0.16 development] documentation built by [http://forum.freecadweb.org/viewtopic.php?t=12613 qingfeng.xia]. |
|||
<div class="mw-translate-fuzzy"> |
<div class="mw-translate-fuzzy"> |
||
Line 33: | Line 67: | ||
</div> |
</div> |
||
<div class="mw-translate-fuzzy"> |
|||
==== Coin3Dドキュメントの統合 ==== |
==== Coin3Dドキュメントの統合 ==== |
||
</div> |
|||
<div class="mw-translate-fuzzy"> |
|||
UNIX系ではCoin3DのソースドキュメントをFreeCADのものとリンクすることが可能です。 |
UNIX系ではCoin3DのソースドキュメントをFreeCADのものとリンクすることが可能です。 |
||
これを行うと移動が楽になり、またCoin派生クラスの継承ダイアグラムを作成できます。 |
これを行うと移動が楽になり、またCoin派生クラスの継承ダイアグラムを作成できます。 |
||
</div> |
|||
<div class="mw-translate-fuzzy"> |
|||
* Debianとそこから派生したシステムの場合: |
* Debianとそこから派生したシステムの場合: |
||
: - パッケージlibcoin60-docをインストール |
: - パッケージlibcoin60-docをインストール |
||
Line 43: | Line 82: | ||
: - ソースドキュメントを再生成 |
: - ソースドキュメントを再生成 |
||
: オフラインでのブラウジングができます。 |
: オフラインでのブラウジングができます。 |
||
</div> |
|||
<div class="mw-translate-fuzzy"> |
|||
* もしCoinのドキュメントパッケージをインストールしたくない/できない場合、設定時(wget)にDoxygenタグファイルがダウンロード可能であればdoc.coin3D.orgにあるオンラインのCoinドキュメントへのリンクが生成されます。 |
* もしCoinのドキュメントパッケージをインストールしたくない/できない場合、設定時(wget)にDoxygenタグファイルがダウンロード可能であればdoc.coin3D.orgにあるオンラインのCoinドキュメントへのリンクが生成されます。 |
||
</div> |
|||
== How to integrate doxygen in to the FreeCAD source code == |
== How to integrate doxygen in to the FreeCAD source code == |
Revision as of 10:18, 13 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 your 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 500 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
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
- 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