ดาวน์โหลด valadoc org - ดาวน์โหลดซอร์สโค้ด valadoc org

valadoc org

ข้อมูลเว็บไซต์

1.0.0

ดาวน์โหลด

valadoc.org

ยังคงกรุบกรอบแม้ในนม

แพ็คเกจนี้มีเครื่องมือสร้างที่ใช้ในการสร้าง valadoc.org และไม่ควรใช้ในการสร้างหน้าอื่น ๆ

อาคาร

ในการสร้างเอกสารคุณจะต้องมีสิ่งต่อไปนี้:

valadoc > = 0.35.0
php
พื้นที่ว่าง 4 GB

บนระบบปฏิบัติการระดับประถมศึกษาหรือ Ubuntu Run:

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

การวิ่งโค้งหรืออนุพันธ์:

pacman -S vala php

ถัดไปติดตั้งการพึ่งพา JS:

npm install

หลังจากติดตั้ง valadoc แล้วคุณสามารถย้ายไปสร้างเอกสารได้ เพียงแค่วิ่ง:

make serve

สิ่งนี้จะใช้เวลาสักครู่ดังนั้นหยิบกาแฟสักถ้วยให้ตัวเอง หากคุณใจร้อนวิ่ง:

make serve-mini

สำหรับเวอร์ชันทดสอบขั้นต่ำ หากคุณพบข้อผิดพลาดในขั้นตอนนี้โปรดดูส่วนข้อผิดพลาดทั่วไป หลังจากสร้างอาคารเสร็จแล้วคุณควรเห็นโฟลเดอร์ valadoc.org

ในการเข้าถึงเอกสารนำทางเบราว์เซอร์ของคุณไปที่ http: // localhost: 7777

ติดตั้งในพื้นที่

ในการติดตั้งเอกสาร Valadoc เป็นหนังสือ Devhelp ให้สร้างหน้าเว็บด้วย

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

สำหรับเพียงแค่ GIO, GIO และ GOBJECT หรือ

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

สำหรับแพ็คเกจทั้งหมด ซึ่งอาจใช้เวลานานขึ้นเล็กน้อย

หลังจากนั้นคุณสามารถวิ่งได้

sudo make install

ในการติดตั้งหนังสือ DevHelp ในระบบของคุณ ตอนนี้เปิดตัว Devhelp และใช้มัน!

การค้นหา

สำหรับประสบการณ์ที่สมบูรณ์ยิ่งขึ้นคุณจะต้องติดตั้ง Manticore และ xsltproc

บนระบบปฏิบัติการระดับประถมศึกษาหรือ Ubuntu Run:

sudo apt install xsltproc

คำสั่งเรียกใช้ต่อไปนี้เพื่อสร้างดัชนีการค้นหา:

make serve-search

สิ่งนี้จะ (ในที่สุด!) เริ่มต้น Manticore daemon บนพอร์ต 51413

เพิ่มแพ็คเกจใหม่

เปิด documentation/packages.xml และเพิ่มแพ็คเกจใหม่

ใช้ <external-package> package> เพื่อสร้างลิงก์ภายนอก:

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

ใช้ <package> เพื่อสร้างและรวมเอกสารสำหรับไฟล์ VAPI:

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

สนับสนุนคุณลักษณะต่อไปนี้:

ชื่อ	คำอธิบาย
ชื่อ	ชื่อ VAPI
ซึ่งเลิกใช้แล้ว	ตั้งค่าเป็น '"true"' เพื่อทำเครื่องหมายแพคเกจเป็นเลิกใช้แล้ว
ผู้ดูแล	รายชื่อผู้ดูแลที่มีผลผูกพัน
เครื่องราง	ไฟล์ GIR ที่ใช้ในการแยกเอกสารจาก
C-docs	ลิงก์ไปยังเอกสาร C
ไม่สนใจ	อย่าสร้างเอกสารสำหรับรายการนี้
บ้าน	ลิงค์โฮมเพจ
ธง	ธง Vala เพิ่มเติม (ไม่มีการพึ่งพา, ... )
แกลลอรี่	ลิงก์ไปยังแกลเลอรีวิดเจ็ต GTK-DOC
Vapi-Image-Source	แหล่งที่มาดาวน์โหลดภาพจาก

GIR และ vapi-files ที่อ้างอิงต้องเป็นส่วนหนึ่งของหนึ่งในที่เก็บต่อไปนี้:

Vala
Vala-Girs
Vala-Extra-Vapis

เพิ่มตัวอย่างซอร์สโค้ดใหม่

คัดลอกตัวอย่างของคุณไปยัง examples/<vapi-name>/ และเพิ่มรายการใหม่ลงใน 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 >

หากนี่เป็นตัวอย่างแรกสำหรับแพ็คเกจให้เพิ่มบรรทัดไปยังเป้าหมาย check-examples ของ Makefile

เพิ่มเอกสารที่เขียนด้วยลายมือ

สร้างไฟล์ใหม่ที่เรียกว่า <vapi-name>.valadoc ใน documentation/<vapi-name>/ :

 ...

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

 ...

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

ภาพรวมเครื่องมือ

เครื่องกำเนิดไฟฟ้า: parses packages.xml ไฟล์ที่อธิบายแพ็คเกจทั้งหมด มันมีหน้าที่สร้างหน้า มันดึงข้อมูลทรัพยากรเช่นรูปภาพจากแหล่งที่มาคำนวณ valadoc-calls สร้างเอกสารประกอบสำหรับแพ็คเกจที่ระบุและรวมทั้งหน้าทั้งหมด ( make serve make serve-mini )
configGen: ใช้เพื่อสร้างไฟล์การกำหนดค่าสำหรับดัชนีการค้นหาของเรา
Valadoc-Example-Gen: ใช้ภายในเพื่อสร้างรายชื่อตัวอย่าง
Valadoc-Example-Tester: รวบรวมและตรวจสอบตัวอย่างที่ลงทะเบียนทั้งหมด ( make test-examples )