DE AutoDoc 1.2.11 Documentation

Overview

The idea of the automatic documentation is to markup program source code with special comments in order to create the technical documentation automatically using these special comments from the source code.

For special programming languages there exist some tools for this purpose:

• Javadoc^TM for the programming language Java
• Doxygen^TM for the programming languages C, C++, and Java

AutoDoc follows the same idea, but is independent of the underlying programming language.

Although AutoDoc has several options to control the output format, there are two basic output types, AutoDoc is able to create:

1. HTML output
2. LaTeX output
3. Epub E-Book output

The output type is controlled by the parameter -outtype. LaTeX output has been added in version 1.2.0 and Epub output has been added in version 1.2.1. Both are currently experimental.

For recent changes, see the release notes.

For support, please contact AutoDoc@Enache.de.

Contents

• Overview
• Release Notes
• Frequently Asked Questions (FAQ)
• I   Markup Documentation
  1. Overview
  2. Description of Markup Tags
     1. Special Features
     2. File Tags
     3. Structure Tags
     4. Functional Tags
     5. Sub Tags
        1. Source Code Quoting
        2. Include AutoDoc Markup from a File
     6. Inline Tags
     7. Definition of Groups
     8. Multi file languages, like C and C++
     9. Bibliography and Reference Functionality
     10. Examples
         1. File Description Examples
         2. Structure Description Examples
         3. Functional Descriptions Examples
     11. Index of all Tags
• II   Usage Documentation
  1. Introduction
     1. Installation
     2. Installation of Plugins
     3. Quick Start Graphical User Interface (GUI)
     4. Quick Start Command Line Interface
     5. Configuration File
  2. AutoDoc Parameters
     1. Required Parameters (-in, -out)
     2. Input Parameters (-ext, -extdef, -exclude, -recurse)
     3. Output Options Parameters (-outtype, -title, -locale, -chm)
        1. Output Type "frames"
        2. Output Type "treeframes"
        3. Output Type "iframes"
        4. Output Type "itreeframes"
        5. Output Type "noframes"
        6. Output Type "single"
        7. Output Type "latex"
        8. Output Type "pdflatex"
        9. Output Type "epub"
        10. Search Functionality in Output (-enablesearch)
     4. Working Directory (-workdir)
     5. Output Template Parameters (-styledef, -headins, -footins, -templatedir, -logo)
        1. User defined Style Definition File (-styledef)
        2. User defined Insert Files for Header and Footer (-headins, -footins)
        3. User defined Logo image (-logo)
        4. User defined Template Directory (-templatedir)
     6. Configuration File Parameters (-cfg) and File Description
     7. Resource Directory (-res)
• III   Creating Individual Layouts With Templates
  1. Cascading Stylesheet (CSS) Definitions
     1. General Settings
     2. Settings for Documentation Components
     3. Settings for the Tree View
     4. Settings for IFrames and ITreeFrames
  2. Header and Footer Insert Files
  3. Template Files
     1. Introduction
     2. Templ_File.htm and Templ_File_Epub.htm
     3. Templ_Index.htm
     4. Templ_List.htm
     5. Templ_Frames.htm
     6. Templ_IFrames.htm
     7. Templ_LaTeX.tex
     8. Templ_PDFLaTeX.tex
• IV   Extending AutoDoc for Experts
  1. Introduction
  2. Documentation of Parameter Files
     1. AutoDoc Tag Dictionary
     2. AutoDoc Tag Texts
     3. AutoDoc Message Texts
     4. Groupings Definitions
     5. Standardized User Grouping Definitions
     6. File Extensions Defaults
  3. How to Accomplish Tasks
     1. Adding an Alias for an Existing Tag
     2. Overwriting an Exisiting Tag
     3. Adding a New Simple Tag
     4. Creating a new Grouping for the TreeView

Terms and Conditions

Copyright (c) 2008-2017 by Daniel Enache.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.