開発者向けガイド¶
このドキュメント集には、|Gromacs|の開発に関するガイドライン、手順、および説明が含まれています。実際のコードは、以下のDoxygenドキュメントで説明されています。
現在は、コード自体に密接に関連する項目に重点が置かれています。具体的には、ソースリポジトリ内に存在するヘルパースクリプトや、コードの構造そのものなどであり、これらの項目を最新の状態に保つためには、ドキュメントも同時に更新する必要があります。
このガイドは現在、いくつかの主要なセクションに分割されています。
GROMACS コードベースの概要。
重要な実装に関する側面を説明する概要ページのコレクション。
一般的なGromacs開発時のガイドライン。これらのガイドラインの一部については、スクリプト（下記参照）があり、これらを使用してコードを自動的に再フォーマットしたり、各コミットに対してガイドラインを強制したりすることができます。
使用するツールとその使用方法に関する手順。
さらに、C/C++コードのコメントから抽出されたDoxygenドキュメントは、既存のコードを文書化するために利用できます。
実際のC/C++コードに関連する、ある程度の概要説明はDoxygenのドキュメントに記載されています。また、その他の概要情報は開発者向けガイドに記載されています。その理由は技術的な側面も含まれていますが、関連する情報が両方のソースに分かれて記述されている場合、開発者向けガイドとDoxygenのドキュメントの間でクロス参照が提供されます。
このドキュメントはまだすべての分野を網羅していませんが、新しいコンテンツが（ゆっくりと）追加されています。
ドキュメント¶
公開APIドキュメントこのドキュメントには、インストールされたヘッダーに表示されるコードのドキュメント、およびそれらのコードの理解を助けるための概要ドキュメントが含まれています。ただし、公開APIの定義は非常に初期段階であり、変更される可能性があることにご注意ください。特に、ドキュメント化されていない部分については、定義が変更される可能性があります。
コードドキュメントこれは、GROMACS のパブリック API ドキュメントの一部を含んでいますが、内部の実装の詳細も含まれています。これは、たとえば、コードの特定の領域を理解し、貢献するための良い出発点です。
完全なドキュメントこのドキュメントには、コードベースに存在するすべての関数が記載されています。これには、内部関数も含まれます。詳細が多岐にわたるため、コードベース内で特定の関数を見つけるのに役立ちます。