Documentação HTML
É possível exportar para HTML a documentação ProtheusDoc de todos os fontes de uma Workspace, para isso basta executar o comando: Ctrl + Shift + P > ProtheusDoc - Gerar documentação HTML - Workspace.
É possível gerar a documentação dos fontes de uma pasta específica, para isso basta clicar com o botão direito do mouse em uma pasta da Explorer, e selecionar o comando ProtheusDoc - Gerar documentação HTML - Pasta:
É possível gerar a documentação de um arquivo específico. Para isso basta clicar com o botão direito do mouse em um arquivo da Explorer ou dentro do editor do VsCode, e selecionar o comando ProtheusDoc - Gerar documentação HTML - Arquivo:
Para gerar a documentação de todos os arquivos abertos, basta clicar com botão direito do mouse no editor do VsCode, no título do arquivo ou no ... do contexto do editor do VsCode e selecionar o comando ProtheusDoc - Gerar documentação HTML - Arquivos abertos. Também é possível executar este comando direto da paleta de comandos: Ctrl + Shift + P > ProtheusDoc - Gerar documentação HTML - Arquivos abertos.
Executado um dos comandos acima a extensão irá criar uma estrutura HTML contendo a documentação ProtheusDoc de cada arquivo da Workspace ou pasta.
Por padrão será criado uma pasta html-out no primeiro diretório da Workspace, mas é possível alterar a pasta e o diretório onde os arquivos serão criados. Para isso veja a Wiki de Configurações.
Importante: Caso a estrutura de pastas da documentação já exista, esta será sobrescrita sempre que uma nova documentação for gerada.
Para consultar as documentações ProtheusDoc em HTML basta executar o comando: Ctrl + Shift + P > ProtheusDoc - Abrir documentação HTML, ou caso tenha acabado de gerar a documentação, no botão "Abrir documentação" da notificação.
Será verificado na Workspace (ou no diretório das configurações definidas) se existe a pasta com a estrutura HTML das documentações, e a documentação será aberta no navegador padrão do sistema operacional.
No lado esquerdo da página será exibido a árvore de diretórios e arquivos Protheus da Workspace (que contenham documentação ou não). Também é possível buscar por um identificador específico (função, classe ou método).
No lado direito da página será exibido as documentações do arquivo selecionado ou da busca efetuada.
Importante: Para que seja exibido a documentação HTML, é necessário que as extensões de arquivo *.html estejam relacionadas com um navegador default.
Para geração da documentação HTML, a extensão utiliza o projeto NPM: https://github.com/robsonrosilva/protheusDoc. Sendo assim issues referente a problemas ou melhorias devem ser abertas neste repositório do GitHub, para melhor controle dos ajustes.