Menu

Asm4Doxy

Bogdan Drozdowski

Asm4Doxy

Asm4Doxy is a Perl script that transforms specially-formatted assembly language files into something Doxygen can understand.
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
  • Cwd
  • File::Spec::Functions
  • Getopt::Long
  • PerlIO::encoding

Command-line arguments

-encoding <name>                Source files' character encoding
-h|--help|-help|-?              Shows the help screen
-L|--license                    Shows the license for this program
-od|-odir|-output-directory     Set output directory to input directory
-ud|-undoc|-undocumented        Process undocumented procedures
-ns|-nosort|-no-sort            Do not alphabetically sort procedures, structures and data
-version                        Show Asm4Doxy version

Related

The Asmosis Blog: 2024/04/documentation-generators-v44-released
Wiki: Asmosis tools