Doc4GL documentation index page

Please note:

English language documents are translated from Portuguese language version by non-native English speaker, and/or automated software based translation. In the process, some constructs and wordings are confusing, or meaningless and incorrect completely. We are working on it. Thank you for your understanding and support.

English

• Users manual

  • Introduction

    • About this document

    • Background

    • About DOC4GL

    • For the impatient

    • Compilation

    • Installation

    • Execution

  • Components

    • "fgldoc" - Interface for execution of documentation commands

    • CUI interface

    • GUI interface

    • Web browser interface

  • Working with DOC4GL

    • Configuration file

    • Parser and loader

    • Repository

    • Documenting existing project

    • Documenting new project

  • Future versions

  • Support

  • Compatibility

  • License

• Technical Manual

  • Introduction
  • Architecture 
    • Repository
    • Documenter
      • Parser and Extractor of documentation from 4gl source code
      • Access to the repository
      • Exporter for 4gl source files
      • CSV Importer 
      • CSV Exporter 
      • HTML generation
    • Web Navigator
  • Repository Data Model
  • Functional structure (missing)
  • Modular structure (missing)
  • Dependencies
  • Installation and Compilation instructions
  • Configuration file
• Writing documentation comments for DOC4GL
  • Basic principles
  • Terminology
  • Source files
  • General form of a documentation comment
  • Description
  • Style guide
  • Conventions for tagging
  • Comments describing functionality (missing)
  • Examples
• Testing sheet for DOC4GL application

On-line generated documentation examples:

• Static HTML

• Dynamic HTML, Java Server Pages/Java Servlet based, using Tomcat/Informix RDBMS via JDBC

On-line documentation for developers:

• On-line API documentation for all Doc4GL components

• Browse the CVS code on-line

Portuguese

• Documentador de 4GL

• Manual Técnico

• Guidelines

• Plano de Testes do Projecto FGL-Documenter

This manual was prepared by Sergio Alexandre Ferreira (MoreData) and Andrej Falout. Please report corrections and omissions to the Aubit 4gl project mailing list.

Manual version 0.10, last modified on 28/12/2001

Aubit 4gl project documentation menu  Aubit 4gl project