Diferenças

Aqui você vê as diferenças entre duas revisões dessa página.

--- geopro:pedro:estagio-probatorio:luadoc [2009/09/02 17:36] – created pedro
+++ geopro:pedro:estagio-probatorio:luadoc [2009/12/17 16:41] (atual) – pedro
@@ Linha 1: / Linha 1: @@
 ====== Problemas com Luadoc ======
-- Temos o TerraME.lua em um unico arquivo. Desta forma, o luadoc acaba
+===== TerraME.lua =====
+Temos o TerraME.lua em um unico arquivo. Desta forma, o luadoc acaba
 colocando tudo em uma unica pagina. nao achei jeito de fazer ele colocar
 em paginas diferentes a nao ser separando cada "tipo" em um arquivo
@@ Linha 7: / Linha 9: @@
 etc., se quisermos usar esta forma de documentacao.
-- os "construtores" dos tipos recebem como argumento uma tabela, por
+===== Construtores =====
+Os "construtores" dos tipos recebem como argumento uma tabela, por
 isto usamos os {} para separar os argumentos. Desta forma, a assinatura
 das funções é do tipo
@@ Linha 38: / Linha 42: @@
 diretamente. Mas isto ficaria muito porco.
-- as funções internas das classes, como o getNeighborhood tambem
+===== Funções das classes =====
+As funções internas das classes, como o getNeighborhood tambem
 recebem um parametro a mais, no caso o self. Mas ai acho que o usuario
 de lua tem que saber que os ":" evita o uso deste argumento.
+===== Passos para Documentação TerraME.lua =====
+  - Documentar onde estão e como alterar os templates de formatação do HTML gerado pelo LuaDoc.
+  - Estudar o luaQT para ver se foi feita alguma alteração ou algo diferente do que está implementado no LuaDoc.
+  - Adicionar tipo "invisible" ao LuaDoc, para apontar objetos que não serão documentados.
+  - Adicionar novo tipo "constructor" ao LuaDoc, que tem uma tabela como único argumento. Os elementos desta lista serão descritos como parâmetros da função. Procurar por tabela.x dentro da função para apontar os seus elementos.
+  - Adicionar campo "example" para a documentação.
+  - Pegar documentação pronta do "Relatório 2" e colocar no código Lua.
+  - Separar o TerraME.lua em vários arquivos para a documentação separada.