Source documentation/ja: Difference between revisions

From FreeCAD Documentation
No edit summary
(Created page with "Wikiに加えて''ソースドキュメント''を読むことでその感覚が緩和され、取っ掛かりを見つけて、数十ものファイルやディレクトリ...")
Line 5: Line 5:
FreeCADの最新のSVN版を追従したい人、C++部分を読むことに挑戦する人がソースを読んでまず思うのはまるで強固な要塞でも見ているようだ、ということでしょう。どこから始まってどこで終わっているのか見当もつかないし、どこから手をつけたらいいかもわからないでしょう!
FreeCADの最新のSVN版を追従したい人、C++部分を読むことに挑戦する人がソースを読んでまず思うのはまるで強固な要塞でも見ているようだ、ということでしょう。どこから始まってどこで終わっているのか見当もつかないし、どこから手をつけたらいいかもわからないでしょう!


Wikiに加えて''ソースドキュメント''を読むことでその感覚が緩和され、取っ掛かりを見つけて、数十ものファイルやディレクトリを簡単に見通せる様になることを願っています。
For those wanting to follow closely the latest development versions of FreeCAD, and who try to have a look at the C++ or Python parts, 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 this Wiki, the [http://www.freecadweb.org/api/ Source Documentation] can hopefully alleviate this feeling, providing an entry point, and allowing for easy browsing through the dozens of files and directories.
In complement to this Wiki, the [http://www.freecadweb.org/api/ Source Documentation] can hopefully alleviate this feeling, providing an entry point, and allowing for easy browsing through the dozens of files and directories.

Revision as of 08:31, 5 January 2019

FreeCADのソースはDoxygenを使って自動でhtmlのドキュメントを生成できるようにコメントがされています。

FreeCADの最新のSVN版を追従したい人、C++部分を読むことに挑戦する人がソースを読んでまず思うのはまるで強固な要塞でも見ているようだ、ということでしょう。どこから始まってどこで終わっているのか見当もつかないし、どこから手をつけたらいいかもわからないでしょう!

Wikiに加えてソースドキュメントを読むことでその感覚が緩和され、取っ掛かりを見つけて、数十ものファイルやディレクトリを簡単に見通せる様になることを願っています。

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

ソースドキュメントのビルド

Doxygenをインストールしてあればドキュメントのビルドは非常に簡単です。FreeCADビルド用のディレクトリに移動してCMakeでソースを設定した上で次のコマンドを実行します:

make DevDoc

その後でDoc/SourceDocu/html/index.htmlから始まる結果のhtmlファイルを調べてください。

(注意:DevDocターゲットは自動ツールビルドでは有効になっていません)その性質上、ソースドキュメントは常に作業進行中状態にあります。よく起きることですが必要がある時にはためらわずに再ビルドを行なってください。もし明らかな不備を見つけた場合には遠慮無くフォーラムに投稿してください(注意:CMakeビルドプロセスでしか全体のチェックは行われていません)。

make WebDoc

またこれとは別にこのドキュメントは折を見て生成されては、sourceforgeのここでアクセス可能な状態で置かれています。

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

Here is another FreeCAD Doxygen documentation generate by 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 is a Work In Progress. See Doxygen

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

Extra python modules
List of Commands