Table of Content

 

List of Tables and Figures

    1. Introduction

      1.1 Background

        1.1.1  Year 2000 Problem

        1.1.2  Cause of Y2K Problem

        1.1.3  Impact of Y2K Problem

        1.1.4  Overcoming the Y2K Problem

        1.1.5  The Need for an Automated Documentation System

      1.2 Scope and Objective

      1.3 Project Schedule

      1.4 Organisation of Report

    2. System Analysis

      2.1 Case Studies One: Doxygen

      2.2 Case Studies Two: Javadoc

      2.3 Requirement Analysis

    3. Design and Implementation

      3.1 The System

        3.1.1  System Modularity

        3.1.2  System Context

      3.2 The Database

        3.2.1  Database Overview

        3.2.2  Database Design

        3.2.3  Database Format

        3.2.4  Database Creation

        3.2.5  Database Retrieval

        3.2.6  Database Update

      3.3 Plugins

        3.3.1  Plugin Concept

        3.3.2  Plugin Implementation

        3.3.3  Import Plugins

        3.3.4  Export Plugins

        3.3.5  General Plugins

        3.3.6  Plugin Management

       

      3.4 The Interface Module

        3.4.1  Module Overview

        3.4.2  Development Environment

        3.4.3  User Interface

        3.4.4  Document Browser

        3.4.5  Structure Charts

        3.4.6  Description Entry

        3.4.7  Putting all together

      3.5 The Import Module

        3.5.1  Import Module Overview

        3.5.2  ANSI C Import Module

        3.5.3  Information Generated

        3.5.4  Import Module Implementation

      3.6 The Export Module

        3.6.1  Export Module Overview

        3.6.2  The HTML Export Module

        3.6.3  Module Implementation

        3.6.4  Generated HTML Documentation

      3.7 The Lexical Analyser

        3.7.1  Analyser Overview

        3.7.2  Analyser Implementation

      3.8 The Parser

        3.8.1  Parser Overview

        3.8.2  Parser requirements

        3.8.3  Parser Implementation

      3.9 The GIF Encoder

        3.9.1  Encoder Overview

        3.9.2  Encoder Implementation

    4.  Recommendations

    5.  Conclusion

Reference

[Home|Content|Previous|Next]