AsmDoc

AsmDoc

AsmDoc is a Perl script that mimics the javadoc tool for assembly language - it generates HTML documentation for annotated assembly language source files,
Documentation comments should start with ;; or /** and end with ;; or */.

Example:

    ;;
    ; This procedure reads data.
    ; @param CX - number of bytes
    ; @return DI - address of data
    ;;
    procedure01:
            ...
            ret

Requirements

The current requirements can always be found in the script itself. As of this writing, they are:

• Perl 5.8.0 (or newer)
• Cwd
• Encode
• Fcntl
• File::Copy
• File::Spec::Functions
• I18N::Langinfo
• I18N::LangTags::Detect
• Getopt::Long
• PerlIO::encoding

Command-line arguments

-author                         Add @author information
-bottom <HTML-code>             Add the given text at the bottom of every page
-charset|-docencoding <name>    Charset which will be put in the HTML files
-d <directory>                  Put resulting files in the given directory
-doctitle <HTML-code>           Add the given title to the overview page
-encoding <name>                Source files' character encoding
-footer <HTML-code>             Add the given footer on every page
-h|--help|-help|-?              Shows the help screen
-header <HTML-code>             Add the given header on every page
-helpfile <file>                Include this help file instead of a default one
-ida|-idapro                    Enable IDA Pro mode
-L|--license                    Shows the license for this program
-lang <2-letter code>           Generates the docs in the language specified by the code, e.g. DE, EN (if supported)
-nocomment                      Skip tags and description, generate declarations
-nodeprecated                   Do not add @deprecated elements
-nodeprecatedlist               Do not create a list of deprecated elements
-nohelp                         Do not generate a help file
-noindex                        Do not generate an index
-nonvabar                       Do not include a navigation bar in the files
-nosince                        Do not add @since <version> information
-ns|-nosort|-no-sort            Do not alphabetically sort procedures, structures and data
-overview <file>                Read overview documentation from the given file
-stylesheetfile <file>          Stylesheet file
-top <HTML-code>                Add the given text at the top of every page
-ud|-undoc|-undocumented        Process undocumented procedures
-V                              Show AsmDoc version
-version                        Add @version information
-windowtitle <text>             Set web browser window title