infistream

Membuat Dokumentasi doxygen

Dokumentasi Doxygen yang dihasilkan memungkinkan pembaca untuk dengan cepat menemukan informasi tentang kelas yang dibahas. Sistem dokumentasi Doxygen menghasilkan dokumentasi HTML yang dapat dibuka menggunakan peramban web, dengan keuntungan melihat diagram kelas dan kolaborasi dengan elemen yang terhubung. Ini sangat membantu ketika interaksi antara kelas dan algoritma diselidiki. Mengikuti tautan dalam peramban HTML ke kelas dasar mungkin lebih efektif bagi sebagian besar pembaca dibandingkan dengan menjelajahi kode sumber menggunakan editor teks. Sebagai alternatif, Lingkungan Pengembangan Terpadu (IDE) mungkin digunakan saat bekerja dengan OpenFOAM dengan dukungan untuk menjelajahi kode sumber. Untuk memulai belajar OpenFOAM, kami merekomendasikan penggunaan editor teks dan dokumentasi yang dihasilkan Doxygen. Menyiapkan IDE untuk bekerja dengan OpenFOAM mungkin merupakan tugas yang kompleks bagi pengguna OpenFOAM pemula.

Untuk menghasilkan dokumentasi, Allwmake perlu dijalankan di folder

Setelah Doxygen selesai menghasilkan dokumentasi, file tersebut dapat dilihat dengan peramban web. Halaman ini merupakan halaman awal bantuan HTML lokal dari instalasi OpenFOAM. Sebagai alternatif, dokumentasi berbasis LATEX tersedia. Dokumentasi ini tersedia dalam format PDF tetapi harus dikonversi secara manual.


Open chat
Infichat
Hello 👋
Thank you for text me
Can we help you?