valadoc org
1.0.0
Permanece crocante, mesmo no leite.
Este pacote contém ferramentas de construção usadas para gerar valadoc.org e, idealmente, não devem ser usadas para gerar outras páginas.
Para construir os documentos, você precisará do seguinte:
valadoc > = 0,35.0phpNo sistema operacional elementar ou ubuntu:
sudo add-apt-repository ppa:vala-team
sudo apt update
sudo apt install valac valadoc libvaladoc-dev unzip php php-curlArco ou derivados executados:
pacman -S vala phpEm seguida, instale as dependências JS:
npm install Depois de instalar valadoc , você pode mudar a documentação. Basta correr:
make serveIsso levará um pouco de tempo, então pegue uma xícara de café; Se você está impaciente, corra:
make serve-mini Para uma versão mínima de teste. Se você encontrar um erro nesta etapa, consulte a seção de armadilhas comuns. Depois de concluir o prédio, você deve ver uma pasta valadoc.org .
Para acessar a documentação, navegue pelo seu navegador para http: // localhost: 7777.
Para instalar a documentação do Valadoc como livros devhelp, primeiro construa as páginas com qualquer
make build-docs-mini build-data GENERATOR_OPTS=--skip-existingpor apenas glib, gio e gobject, ou
make build-docs build-data GENERATOR_OPTS=--skip-existingPara todos os pacotes. Isso pode demorar um pouco mais.
Depois disso você pode correr
sudo make installPara instalar os livros devhelp em seu sistema. Agora inicie o Devhelp e use -os!
Para uma experiência mais completa, você precisará instalar Manticore e xsltproc .
No sistema operacional elementar ou ubuntu:
sudo apt install xsltprocO comando execute o seguinte para gerar índices de pesquisa:
make serve-search Isso (eventualmente!) Começará um daemon Manticore na porta 51413 .
Abra documentation/packages.xml e adicione uma nova entrada de embalagem.
Use <external-package> para criar links externos:
< external-package name = " package-name " link = " http://path/to/docs " >
short description
</ external-package > Use <package> para construir e incluir documentação para arquivos VAPI:
< package name = " gdl-1.0 " >
short description
</ package >Os seguintes atributos são suportados:
| Nome | Descrição |
|---|---|
| nome | O nome VAPI |
| descontinuado | Defina -o como '"true"' para marcar um pacote como depreciado |
| mantenedores | Lista de mantenedores vinculativos |
| Gir | O arquivo gir usado para extrair documentação de |
| C-Docs | Link para C Documentação |
| ignorar | Não crie documentação para esta entrada |
| lar | Link da página inicial |
| bandeiras | Bandeiras de Vala adicionais (falta de dependências, ...) |
| galeria | Link para uma galeria de widgets GTK-Doc |
| São-fogueira Vapi | Fonte para baixar imagens de |
GIR de referência e pratos Vapi devem fazer parte de um dos seguintes repositórios:
Copie seus exemplos para examples/<vapi-name>/ e adicione uma nova entrada aos 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 > Se este for o primeiro exemplo do pacote, adicione uma linha ao alvo check-examples do Makefile .
Crie um novo arquivo chamado <vapi-name>.valadoc em documentation/<vapi-name>/ :
...
/**
* My valadoc comment
*/
c::c_symbol_name
...
/**
* My valadoc comment
*/
Vala.Symbol.Name
packages.xml Descrevendo todos os pacotes. É responsável por criar a página. Ele busca recursos como imagens de fontes especificadas, calcula-se-calls, cria documentação para pacotes especificados e coloca a página inteira. ( make serve , make serve-mini )make test-examples ) Uncaught Error: Class 'mysqli' not found
extension=mysqli.so no seu sistema operacional Php.ini ( find /etc -name php.ini ) error: failed to load driver
VALAC_VERSION no makefile.Outros erros:
LOG na raiz deste repositório para obter mais informações
