[Eos-document] [eos - ドキュメント作成] Re: 【API関連】APIドキュメントと設定データの関係

Back to archive index

SourceForge Forum norep****@sourc*****
2014年 5月 16日 (金) 09:43:27 JST


このメールはSourceForge.JPのフォーラムからの自動転送です。
注意: このメールに返信しても単に無視されます。

フォーラムメッセージへの返信は以下のURLにアクセスしてください:
https://sourceforge.jp/projects/eos/forums/31695/35450/73029/

投稿者: kinoshita-eos (kinoshita-eos)

[メッセージ #73023 の追記]
> 固有の構造体を設定データとして引数にするAPIは構造体と
相互リンクを貼る

説明が不足していました。上記の案は
/src/Objects/DataManip/mrcImage/inc/mrcImage.h
のような定義が多いファイルについてです。

相互リンクを貼らなくても検索すれば良い話ですが、
私自身が何度も見返すケースがあったので、話題とさせて
頂きました。

しかし、定義が多く情報が埋もれてしまう恐れが有るファ
イルは
inc内のファイルくらいだと思いますので、
あまり気にすることではないかもしれません。


この件はこだわらずに「APIの内容を出来るだけ多く記載す
ることを優先」し、
細かい工夫などはその都度で少しずつ加えていこうかと思
います。

______________________________________________________________________
Eos-Image Analysis Environment プロジェクトはフォーラムへの投稿をプロジェクトメンバーに
メール送信するように設定されています。
設定の詳細に関しては、プロジェクト管理者に確認してください。




Eos-document メーリングリストの案内
Back to archive index