docc2json
Alat baris perintah Go cepat yang mengubah dokumentasi DocC menjadi skema JSON terstruktur untuk situs web dan SDK.
docc2json: Ubah dokumentasi DocC Xcode Anda menjadi file JSON siap pakai untuk API. Mudah di-host, format terstruktur, dan dioptimalkan untuk situs web dokumentasi dan SDK.
Lebih banyak tentang docc2json
docc2json
docc2json adalah alat CLI Go cepat yang mengurai keluaran dokumentasi DocC Apple dan mengubahnya menjadi skema JSON terstruktur yang bersih yang dioptimalkan untuk situs dokumentasi web dan SDK. Alat ini membantu Anda membuat dokumentasi SDK yang mudah digunakan.
- •Ekstraksi dokumentasi komprehensif:Ekstrak abstrak, diskusi, contoh, dan daftar kode dari komentar DocC.
- •Menghasilkan skema SDK khusus:Menghasilkan skema SDK khusus dengan informasi tipe lengkap, tanda tangan metode, dan dokumentasi.
- •Mendukung pengelompokan fleksibel:Kelompokkan tipe dengan awalan atau konfigurasi khusus untuk organisasi yang lebih baik.
- •Pemrosesan paralel cepat:Memproses file JSON secara bersamaan menggunakan goroutine, meningkatkan kinerja.
- •Resolusi lintas-referensi:Menyelesaikan referensi silang untuk hubungan tipe dan kesesuaian protokol.
- •Dukungan artikel dan tutorial:Sertakan artikel dan tutorial dokumentasi secara opsional.
- •Filter tingkat akses:Filter simbol API berdasarkan tingkat akses dengan bendera --public-only.
- •Unmangling protokol otomatis:Mengonversi nama protokol Swift yang diacak (misalnya, s8SendableP) ke nama bersih (Sendable).
- •Filter kesesuaian cerdas:Filter protokol stdlib sambil mempertahankan protokol khusus.
Dengan memilih docc2json, Anda menyederhanakan alur kerja dokumentasi Anda. Alat ini mengubah dokumentasi DocC menjadi format JSON yang mudah digunakan, meningkatkan efisiensi pengembangan. Manfaatkan kemampuan untuk menghasilkan dokumentasi SDK yang terstruktur dengan baik, memastikan pengalaman pengembang yang lebih baik.
