保持鬆脆,即使在牛奶中也是如此。
該軟件包包含用於生成valadoc.org的構建工具,理想情況下不應用於生成其他頁面。
為了構建文檔,您需要以下內容:
valadoc > = 0.35.0php在基本操作系統或Ubuntu運行中:
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。
要以Devhelp書籍安裝Valadoc文檔,請首先用任何一個構建頁面
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運行中:
sudo apt install xsltproc運行以下命令生成搜索索引:
make serve-search這將(最終!)在港口51413上啟動Manticore守護程序。
打開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名稱 |
| 棄用 | 將其設置為'true',以將包裝標記為已棄用 |
| 維護者 | 綁定維護者列表 |
| 吉爾 | GIR文件用於從中提取文檔 |
| C-Docs | 鏈接到C文檔 |
| 忽略 | 不要為此條目構建文檔 |
| 家 | 首頁鏈接 |
| 標誌 | 其他vala標誌(缺少依賴關係,...) |
| 畫廊 | 鏈接到GTK-DOC小部件畫廊 |
| Vapi Image-Source | 從中下載圖像的來源 |
引用的GIR和VAPI文件必須是以下存儲庫之一:
將您的示例複製到examples/<vapi-name>/ ,然後將新條目添加到examples/<vapi-name>/<vapi-name>.valadoc.examples :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 >如果這是軟件包的第一個示例,請在Makefile的check-examples目標中添加一行。
在<vapi-name>.valadoc documentation/<vapi-name>/ ::
...
/**
* My valadoc comment
*/
c::c_symbol_name
...
/**
* My valadoc comment
*/
Vala.Symbol.Name
packages.xml文件描述所有軟件包。它負責構建頁面。它獲取了來自指定來源的圖像之類的資源,計算valadoc-calls,為指定的軟件包構建文檔,並將整個頁面放在整個頁面上。 ( make serve , make serve-mini )make test-examples )Uncaught Error: Class 'mysqli' not found
extension=mysqli.so在您的操作系統php.ini中( find /etc -name php.ini ) error: failed to load driver
VALAC_VERSION 。其他錯誤:
LOG以獲取更多信息