تنزيل valadoc org - تنزيل رمز المصدر valadoc org

valadoc org

بيانات الموقع

1.0.0

تنزيل

Valadoc.org

يبقى مقدد ، حتى في الحليب.

تحتوي هذه الحزمة على أدوات الإنشاء المستخدمة لإنشاء valadoc.org ، ومن الناحية المثالية ، لا ينبغي استخدامها لإنشاء صفحات أخرى.

مبنى

من أجل إنشاء المستندات ، ستحتاج إلى ما يلي:

valadoc > = 0.35.0
php
4 غيغابايت من المساحة الحرة

على نظام التشغيل الابتدائي أو 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

فقط glib و 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> لإنشاء روابط خارجية:

< 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
تم إهماله	قم بتعيينه على "صحيح" "لتحديد الحزمة كما تم إهمالها
المشرفون	قائمة من المشرفين الملزمة
جير	ملف GIR المستخدم لاستخراج الوثائق من
C-Docs	رابط إلى C Documentation
يتجاهل	لا تبني وثائق لهذا الإدخال
بيت	رابط الصفحة الرئيسية
أعلام	أعلام فالا إضافية (التبعيات المفقودة ، ...)
معرض	رابط إلى معرض واجهة المستخدم GTK-DOC
vapi-emage المصدر	مصدر لتنزيل الصور من

يجب أن تكون ملفات GIR و VAPI المشار إليها جزءًا من أحد المستودعات التالية:

فالا
فالا جيرز
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 ملفات تصف جميع الحزم. وهي مسؤولة عن بناء الصفحة. إنه يجلب موارد مثل الصور من المصادر المحددة ، ويحسب Cooldoc-Cards ، ويبني وثائق للحزم المحددة ويضع الصفحة بأكملها. ( make serve ، make serve-mini )
Configgen: يستخدم لإنشاء ملفات التكوين لفهرس البحث الخاص بنا.
Valadoc-example-gen: يستخدم داخليًا لإنشاء قوائم مثال.
Valadoc-example-Tester: تجميع وتفتيش جميع الأمثلة المسجلة. ( make test-examples )