Ticket #1031 (new task)

Opened 8 years ago

Last modified 8 years ago

Gerar documentação dos modulos do webapp

Reported by: raphael.costa Owned by: raphael.costa
Priority: major Milestone: terrama2-4.0.0-beta2
Component: gui-web Version: 4.0
Keywords: Cc:
Parent Tickets: Platform: WLA

Description

Gerar documentação dos modulos do webapp. Adotar o mesmo mecanismo no TerraMA2 webcomponentes (grunt e jsdoc) com uma categorização. Como o sistema web baseia-se em "backend" e "front-end", é necessario desacoplar a documentação para saber o que é view e o que é funcionalidade.

Sugestões:
Module/Namespaces Stackoverflow

Module Jsdoc

Observação
Grande parte dos modulos estão documentados, porém nem todos possui diretivas suficientes necessarias para uma boa formatação na geração final.

Subtickets (add)

Change History

comment:1 Changed 8 years ago by raphael.costa

Foi preparado a instalaçao e configuração da documentação do TerraMA² WebApp. Agora será necessario revisar toda a doc para re-agrupar e gerar uma documentação adequada.

Segue abaixo com as configs:

  • package.json
      ...
    
      "devDependencies": {
        "grunt-jsdoc": "^2.1.0",
        "jsdoc": "^3.4.3"
      }
    
  • Gruntfile:
    jsdoc : {
      TerraMA2WebAppFrontEnd: {
        src: ['README.md'],
          options: {
            configure: '.jsdoc.json',
            destination: 'docs'
          }
        }
      }
    }
    
    ...
    // Loading Grunt Tasks
    grunt.loadNpmTasks('grunt-jsdoc');
    // Registering Tasks into default behaviour
    grunt.registerTask('default', ['clean', 'jsdoc', 'copy', 'requirejs', 'cssmin']);
    
Note: See TracTickets for help on using tickets.