valadoc org

Valadoc.org

Tetap renyah, bahkan dalam susu.

Paket ini berisi alat buatan yang digunakan untuk menghasilkan valadoc.org dan idealnya tidak boleh digunakan untuk menghasilkan halaman lain.

Bangunan

Untuk membangun dokumen, Anda akan membutuhkan yang berikut:

• valadoc > = 0.35.0
• php
• 4 GB ruang kosong

Di OS Elementary atau Ubuntu Run:

sudo add-apt-repository ppa:vala-team
sudo apt update
sudo apt install valac valadoc libvaladoc-dev unzip php php-curl

Lengkungan atau turunan berjalan:

pacman -S vala php

Selanjutnya, instal JS Dependencies:

npm install

Setelah Anda menginstal valadoc , Anda dapat pindah untuk membangun dokumentasi. Cukup jalankan:

make serve

Ini akan memakan waktu sedikit, jadi ambil secangkir kopi; Jika Anda tidak sabar, jalankan:

make serve-mini

untuk versi tes minimal. Jika Anda mengalami kesalahan pada langkah ini, silakan lihat bagian Jebakan Umum. Setelah Anda selesai gedung, Anda akan melihat folder valadoc.org .

Untuk mengakses dokumentasi, navigasikan browser Anda ke http: // localhost: 7777.

Instal secara lokal

Untuk menginstal dokumentasi valadoc sebagai buku devhelp, pertama -tama buat halaman dengan salah satu

make build-docs-mini build-data GENERATOR_OPTS=--skip-existing

hanya untuk glib, gio dan gobject, atau

make build-docs build-data GENERATOR_OPTS=--skip-existing

untuk semua paket. Ini bisa memakan waktu sedikit lebih lama.

Setelah itu Anda bisa lari

sudo make install

Untuk menginstal buku Devhelp di sistem Anda. Sekarang luncurkan Devhelp dan gunakan!

Pencarian

Untuk pengalaman yang lebih lengkap, Anda perlu menginstal Manticore dan xsltproc .

Di OS Elementary atau Ubuntu Run:

sudo apt install xsltproc

Jalankan perintah berikut untuk menghasilkan indeks pencarian:

make serve-search

Ini akan (akhirnya!) Memulai daemon manticore di port 51413 .

Tambahkan paket baru

Buka documentation/packages.xml dan tambahkan entri paket baru.

Gunakan <external-package> untuk membuat tautan eksternal:

< external-package name = " package-name " link = " http://path/to/docs " >
  short description
</ external-package >

Gunakan <package> untuk membangun dan menyertakan dokumentasi untuk file VAPI:

< package name = " gdl-1.0 " >
  short description
</ package >

Atribut berikut didukung:

Nama	Keterangan
nama	Nama VAPI
Tercerahkan	Atur ke '"true"' untuk menandai paket sebagai sudah usang
pemelihara	Daftar Pemelihara yang Mengikat
Gir	File GIR yang digunakan untuk mengekstrak dokumentasi dari
c-docs	Tautan ke Dokumentasi C
mengabaikan	Jangan membangun dokumentasi untuk entri ini
rumah	Tautan beranda
bendera	Bendera VALA tambahan (dependensi yang hilang, ...)
galeri	Tautan ke galeri widget GTK-Doc
Sumber VAPI-IMAGE	Sumber untuk mengunduh gambar dari

Gir dan valifi yang direferensikan harus menjadi bagian dari salah satu repositori berikut:

• Vala
• Vala-girs
• VALA-EXTRA-VAPIS

Tambahkan contoh kode sumber baru

Salin contoh Anda ke examples/<vapi-name>/ dan tambahkan entri baru ke examples/<vapi-name>/<vapi-name>.valadoc.examples :

< example >
  < title >Example Title</ title >
  < image >optional-screenshot.png</ image >
  < file >file-name-1.vala</ file >
  < file >file-name-2.vala</ file >
  < compile >valac file-name1.vala file-name-2.vala ...</ compile >
  < node >Associated.Symbol.name1</ node >
  < node >Associated.Symbol.name2</ node >
</ example >

Jika ini adalah contoh pertama untuk paket, tambahkan baris ke target check-examples Makefile .

Tambahkan dokumentasi tulisan tangan

Buat file baru yang disebut <vapi-name>.valadoc di documentation/<vapi-name>/ :

 ...

/**
 * My valadoc comment
 */
c::c_symbol_name

 ...

/**
 * My valadoc comment
 */
Vala.Symbol.Name

Tinjauan Alat

• Generator: Parses packages.xml File yang menjelaskan semua paket. Ini bertanggung jawab untuk membangun halaman. Ini mengambil sumber daya seperti gambar dari sumber yang ditentukan, menghitung panggilan valadoc, membangun dokumentasi untuk paket yang ditentukan dan menempatkan kumpul-kumpul seluruh halaman. ( make serve , make serve-mini )
• ConfigGen: Digunakan untuk menghasilkan file konfigurasi untuk indeks pencarian kami.
• Valadoc-Example-Gen: Digunakan secara internal untuk menghasilkan daftar contoh.
• Valadoc-Example-Tester: Kompilasi dan periksa semua contoh terdaftar. ( make test-examples )

Jebakan umum

Uncaught Error: Class 'mysqli' not found

• extension=mysqli.so di php.ini OS Anda ( find /etc -name php.ini )

error: failed to load driver

• Versi Valadoc Anda tidak mendukung versi VALA yang diminta. Instal versi VALA baru -baru ini dan kompilasi ulang Valadoc.
• Ubah VALAC_VERSION di Makefile.

Kesalahan lain:

• Periksa LOG di root repo ini untuk informasi lebih lanjut
• Apakah Anda sudah kehabisan ruang disk?

Hubungi dan bantuan

• Beranda, git
• Tracker masalah, valadoc.org
• Pelacak Masalah, Valadoc (sekarang menjadi bagian dari Vala)
• IRC: irc.gnome.org, #vala (flo, UTC+01: 00)
• Mail: [email protected]